From f9708b20462b4d16cfa57373127e2c6efb38e5f0 Mon Sep 17 00:00:00 2001 From: Ray Schamp Date: Thu, 15 Jun 2017 11:24:58 -0400 Subject: [PATCH] Update README for current process The README has gotten a bit out of date and inaccurate. Clarify how to work with scratch-vm in the current state of the project. --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2272e5daf..6bd31f90e 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,11 @@ ## Installation This requires you to have Git and Node.js installed. -In your own node environment/application: +To install as a dependency for your own application: ```bash -npm install https://github.com/LLK/scratch-vm.git +npm install scratch-vm ``` -If you want to edit/play yourself: +To set up a development environment to edit scratch-vm yourself: ```bash git clone https://github.com/LLK/scratch-vm.git cd scratch-vm @@ -22,7 +22,7 @@ npm install ## Development Server This requires Node.js to be installed. -For convenience, we've included a development server with the VM. This is sometimes useful when running in an environment that's loading remote resources (e.g., SVGs from the Scratch server). +For convenience, we've included a development server with the VM. This is sometimes useful when running in an environment that's loading remote resources (e.g., SVGs from the Scratch server). If you would like to use your modified VM with the full Scratch 3.0 GUI, [follow the instructions to link the VM to the GUI](https://github.com/LLK/scratch-gui/wiki/Getting-Started). ## Running the Development Server Open a Command Prompt or Terminal in the repository and run: @@ -31,7 +31,7 @@ npm start ``` ## Playground -To run the Playground, make sure the dev server's running and go to [http://localhost:8073/playground/](http://localhost:8073/playground/) - you will be directed to the playground, which demonstrates various tools and internal state. +To view the Playground, make sure the dev server's running and go to [http://localhost:8073/playground/](http://localhost:8073/playground/) - you will be directed to the playground, which demonstrates various tools and internal state. ![VM Playground Screenshot](https://i.imgur.com/nOCNqEc.gif) @@ -42,7 +42,7 @@ npm run build ``` ```html - +