Skip to content

Commit 6a976de

Browse files
[Node Watch] [Playground] Minor update to docs (microsoft#1505)
- Update comments in `watch.mjs` script after microsoft#1487 - Change relative path to `python ./build.py` for people on linux. This would be convenient for people who use codespaces :-)
1 parent 5d092b6 commit 6a976de

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

playground/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ This is a simple web site built using the Monaco editor and the qsharp npm packa
55
## Building the Playground Locally
66

77
1. Build the entire repo by running `./build.py` in the root directory.
8-
If you only want to build the functionality necessary to run the playground, you can use `python .\build.py --wasm --npm --play`.
8+
If you only want to build the functionality necessary to run the playground, you can use `python ./build.py --wasm --npm --play`.
99
2. Then make `./playground` your current directory and run `npm start` to start the web server.
1010
3. Copy the URL that will be printed to console and open it in a browser to use the playground.
1111

1212
## Building the Playground Locally in Watch Mode
1313

1414
1. Build the entire repo by running `./build.py` in the root directory.
15-
If you only want to build the functionality necessary to run the playground, you can use `python .\build.py --wasm --npm --play`.
15+
If you only want to build the functionality necessary to run the playground, you can use `python ./build.py --wasm --npm --play`.
1616
2. Run `node watch.mjs` at the root of the repo.
1717
3. Copy the URL that will be printed to the console and open it in a browser to use the playground.
1818

watch.mjs

+3-4
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,16 @@ Always use ./build.py to ensure that all projects are built correctly before che
99
Also run ./build.py to do any initial repo setup (npm install, copying 3rd party libs, etc.)
1010
1111
Once running, any changes to the source code for Rust directories listed, or for
12-
the npm, vscode, or playground projects, should automatically recompile. Just
12+
the npm, vscode, docs, katas, samples or playground projects, should automatically recompile. Just
1313
reload the playground page or reload the VS Code window to see the changes.
1414
1515
Notes:
1616
17-
- This builds the wasm module, npm package, VS Code extension, and runs the playground.
17+
- This builds the wasm module, npm package, VS Code extension, docs, katas, samples and runs the playground.
1818
- It does NOT build Python packages or native binaries (currently).
19-
- It does NOT watch for docs, katas, or samples changes (currently).
2019
- It does NOT build the Node.js wasm package (or run any of the node unit tests).
2120
- It builds debug binaries (whereas ./build.py builds for release).
22-
- Future updates could include watching for katas changes, and supporting '--release'
21+
- Future updates could include supporting '--release'
2322
2423
*/
2524

0 commit comments

Comments
 (0)