From 4a366704177381587f924ca5705f2cce4b1c880f Mon Sep 17 00:00:00 2001 From: KernelDeimos Date: Fri, 12 Apr 2024 23:54:41 -0400 Subject: [PATCH] Update README.md files for monorepo'd projects --- packages/phoenix/README.md | 4 +--- packages/puter-js/README.md | 19 ------------------- packages/terminal/README.md | 36 +----------------------------------- 3 files changed, 2 insertions(+), 57 deletions(-) diff --git a/packages/phoenix/README.md b/packages/phoenix/README.md index f9978e8f..c67a626b 100644 --- a/packages/phoenix/README.md +++ b/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 diff --git a/packages/puter-js/README.md b/packages/puter-js/README.md index a9c80bd5..446de801 100644 --- a/packages/puter-js/README.md +++ b/packages/puter-js/README.md @@ -15,25 +15,6 @@ X (Twitter)

-## 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. diff --git a/packages/terminal/README.md b/packages/terminal/README.md index 014b4831..d669fd57 100644 --- a/packages/terminal/README.md +++ b/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.