Skip to content

Commit a0daa52

Browse files
committed
doc update
1 parent b050708 commit a0daa52

File tree

3 files changed

+10
-4
lines changed

3 files changed

+10
-4
lines changed

docs/gettingstarted/installation.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,15 @@ There is no real downside to this installation method, except possibly: (1) it d
4545
git clone https://github.com/twiddlingbits/twr-wasm
4646
~~~
4747

48-
This method of installation installs the complete code base, including source and built binaries.
48+
This method of installation installs the complete code base, including source and built binaries.
4949

50-
The primary downside to this method is that the JavaScript side of twr-wasm will not be placed in a node_modules folder. This will create a little extra work to configure a bundler, TypeScript or VS Code to find the location of imports.
50+
After twr-wasm is cloned, use VS Code `File | Open Folder`.
51+
52+
[See here](https://github.com/twiddlingbits/twr-wasm/blob/main/examples/readme.md) for information on running the examples or building the examples.
53+
54+
[See here](../more/building.md) for information on building the source.
55+
56+
The primary downside to this method is that the JavaScript side of twr-wasm will not be placed in a node_modules folder. This will create a little extra work to configure a bundler, TypeScript or VS Code to find the location of the twr-wasm module imports.
5157

5258
There are a few solutions to this. For example, in the provided Hello World example, a `package.json` file with an `alias` entry is used. This syntax is supported by the Parcel bundler:
5359

docs/more/building.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ mingw32-make
4848

4949
## To Build the Examples
5050

51-
See examples/readme.md for more information.
51+
See [examples/readme.md](https://github.com/twiddlingbits/twr-wasm/blob/main/examples/readme.md) for more information.
5252

5353
To build the examples, but not bundle them.
5454
~~~sh

examples/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Note: Only the "unbundled" version of the examples are available if you don't bu
2626
Note: You must run `python` from the twr-wasm root.
2727

2828
## Execute Examples using Chrome without a local web server
29-
An alternative and simple way to run the examples locally without using a local web server is to use the included VS Code `launch.json`. This file is not included if you install with `npm`. To access this file, you should [install using git clone](https://twiddlingbits.dev/docsite/gettingstarted/installation/). Then from VS Code, select "Run and Debug" in the left menu, and use the "start debugging" button at the top.
29+
An alternative and simple way to run the examples locally without using a local web server is to use the included VS Code `launch.json`. This file is not included if you install with `npm`. To access this file, you should [install using git clone](https://twiddlingbits.dev/docsite/gettingstarted/installation.md#git-install). Then from VS Code, select "Run and Debug" in the left menu, and use the "start debugging" button at the top.
3030

3131
The examples will run without building using chrome and a file:// URL. The file "index.html" can be loaded to provide links to each example. If you are going to run Chrome yourself from a shell, see the section below on some of the Chrome flags you will need to set.
3232

0 commit comments

Comments
 (0)