diff --git a/README.md b/README.md index dcd2314e..c17f4d36 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,27 @@ Please add an issue if you discover an (unreported) bug. Authoring and testing of new extensions can be done directly from the web editor. See [our documentation](https://makecode.com/blog/github-packages) on how to get started. If you want to run the editor locally, keep reading. -## Local server +## Local server setup The local server lets you to run the editor and serve the documentation from your own computer. It is meant for a single developer used and not designed to serve the editor to a large amount of users. +1. Install [Node.js](https://nodejs.org/) 8.9.4 or higher. +2. Clone this repository. +``` +git clone https://github.com/microsoft/pxt-microbit +cd pxt-microbit +``` +3. Install the PXT command line (add `sudo` for Mac/Linux shells). +``` +npm install -g pxt +``` +4. Install the pxt-microbit dependencies. +``` +npm install +``` + +Go to the **Running** section. + ### Developer Setup This is the typical setup used by the MakeCode team to work on the microbit.