diff --git a/README.md b/README.md index 5bba300b..2e4e9fb9 100644 --- a/README.md +++ b/README.md @@ -18,31 +18,31 @@ in [Visual Studio Code](https://github.com/Microsoft/vscode) to power the CSS, L This npm module is bundled and distributed in the [monaco-editor](https://www.npmjs.com/package/monaco-editor) npm module. -## Dev: cheat sheet +* change to your favorite source folder (`/src/`) +* `git clone https://github.com/Microsoft/monaco-editor` (this will create `$/src/monaco-editor`) +* in folder `monaco-editor` run `npm install` and run `npm run simpleserver` +* open [http://localhost:8080/monaco-editor/test/index.html#sample - css](http://localhost:8080/monaco-editor/test/index.html#sample - css) -* initial setup with `npm install .` -* compile with `npm run watch` -* bundle with `npm run prepublish` +## Development -## Dev: Running monaco-css from source - -* clone https://github.com/Microsoft/monaco-css in `$/src/monaco-css` -* run `$/src/monaco-css> npm run watch` -* clone https://github.com/Microsoft/monaco-editor in `$/src/monaco-editor` -* run `$/src/monaco-editor> npm run simpleserver` -* open http://localhost:8080/monaco-editor/test/?monaco-css=dev +### Dev: Running monaco-css from source +* change to your favorite source folder (`/src/`). +* if you haven't done so: `git clone https://github.com/Microsoft/monaco-editor` (this will create `$/src/monaco-editor`) +* `git clone https://github.com/Microsoft/monaco-cs` (this will create `$/src/monaco-css`) +* Important: both monaco repositories must have the same parent folder. +* in folder `monaco-css` run `npm install` and run `npm run watch` +* in folder `monaco-editor` run `npm install` and run `npm run simpleserver` +* open [http://localhost:8080/monaco-editor/test/?monaco-css=dev](http://localhost:8080/monaco-editor/test/?monaco-css=dev) ### [Optional] Running monaco-editor-core from source * this is only needed when you want to make changes also in `monaco-editor-core`. -* clone https://github.com/Microsoft/vscode in `$/src/vscode/` -* run `$/src/vscode> gulp watch` -* open http://localhost:8080/monaco-editor/test/?monaco-css=dev&editor=dev - - -## Installing - -This npm module is bundled and distributed in the [monaco-editor](https://www.npmjs.com/package/monaco-editor) npm module. +* change to the same favorite source folder (`/src/`) that already contains `monaco-css` and `monaco-editor` +* `git clone https://github.com/Microsoft/vscode` (this will create `$/src/vscode/`) +* Important: the vscode and the monaco repositories must have the same parent folder. +* read [here](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#installing-prerequisites) on how to initialize the VS code source repository. +* in folder `vscode` run `gulp watch` +* open [http://localhost:8080/monaco-editor/test/?monaco-css=dev&editor=dev](http://localhost:8080/monaco-editor/test/?monaco-css=dev&editor=dev) ## License -[MIT](https://github.com/Microsoft/monaco-css/blob/master/LICENSE.md) +[MIT](https://github.com/Microsoft/monaco-css/blob/master/LICENSE.md) \ No newline at end of file