浏览代码

Update README.md files for monorepo'd projects

KernelDeimos 1 年之前
父节点
当前提交
4a36670417
共有 3 个文件被更改,包括 2 次插入57 次删除
  1. 1 3
      packages/phoenix/README.md
  2. 0 19
      packages/puter-js/README.md
  3. 1 35
      packages/terminal/README.md

+ 1 - 3
packages/phoenix/README.md

@@ -22,9 +22,7 @@ The shell is a work in progress. The following improvements are considered in-sc
 
 ### In a Browser
 
-You can use the [terminal on Puter](https://puter.com/app/terminal),
-or run from source by following the instructions provided for
-[Puter's terminal emulator](https://github.com/HeyPuter/terminal).
+You can use the [terminal on Puter](https://puter.com/app/terminal), including self-hosted installations.
 
 ### Running in Node
 

+ 0 - 19
packages/puter-js/README.md

@@ -15,25 +15,6 @@
     <a href="https://twitter.com/HeyPuter">X (Twitter)</a>
 </p>
 
-## Installation
-```
-git clone https://github.com/HeyPuter/puter.js.git
-cd puter.js
-npm install
-```
-
-## Run development server
-
-```
-npm start
-```
-
-## Build
-
-```
-npm run build
-```
-
 ### Example
 Make sure the development server is running.
 

+ 1 - 35
packages/terminal/README.md

@@ -21,7 +21,7 @@
 This is a [Puter](https://puter.com)-compatible pure-javascript terminal emulator
 built on [xtermjs](https://xtermjs.org/).
 It integrates with an external shell provider.
-We develop and test the terminal emulator alongside [Puter's shell: phoenix](https://github.com/HeyPuter/phoenix).
+We develop and test the terminal emulator alongside [Puter's shell: phoenix](../phoenix).
 
 ## The Terminal as a Whole
 
@@ -35,37 +35,3 @@ Here are a few examples of what you can do:
 - `echo $(echo "command substitution")`
 - `cat example.txt | grep "find me"`
 - `cat example.json | jq "name"`
-
-## Quickstart
-
-**Note:** we've released Puter's terminal and shell very recently, so you may
-run into some hurdles.
-If you encounter any inconvenience we'd greatly appreciate
-[an issue report](https://github.com/HeyPuter/terminal/issues/new).
-
-The terminal emulator needs a shell to communicate with.
-You can run it with Puter's shell, [phoenix](https://github.com/HeyPuter/phoenix).
-
-1. Clone `phoenix` as a sibling directory to this repo, to get a directory
-   structure like the following:
-   
-   ```
-   my-puter-repos/
-     terminal/
-     phoenix/
-   ```
-2. Ensure you've run `npm install` in both repos
-3. Install `dev-runner`
-   ```
-   npm install -g @heyputer/dev-runner
-   ```
-4. While `cd`'d into this repo, run `run-phoenix-http.json5`
-   ```
-   dev-runner ./run-phoenix-http.json5
-   ```
-5. Navigate to [http://127.0.0.1:8082](http://127.0.0.1:8082),
-   and use the `login` command to access files on puter.com.
-
-   **Note:** You will need to ensure the login popup is allowed.
-   If you choose to allow it _after_ the popup was blocked,
-   it will break; you need to allow always and then reload.