Skip to content

Commit

Permalink
Update README for current process
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
Ray Schamp committed Jun 15, 2017
1 parent 93bac9a commit f9708b2
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand All @@ -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)

Expand All @@ -42,7 +42,7 @@ npm run build
```

```html
<script src="/path/to/vm.js"></script>
<script src="/path/to/dist/web/scratch-vm.js"></script>
<script>
var vm = new window.VirtualMachine();
// do things
Expand Down

0 comments on commit f9708b2

Please sign in to comment.