diff --git a/docs/gettingstarted/helloworld.md b/docs/gettingstarted/helloworld.md index 54b288f1..90b4d3f6 100644 --- a/docs/gettingstarted/helloworld.md +++ b/docs/gettingstarted/helloworld.md @@ -128,6 +128,7 @@ You can run a local server to view your helloworld program. - Execute with the shell command `python server.py`. - Open your web browser and browse to `http://localhost:8000/index.html` - You should see 'Hello World' in the browser window! +- Note: localhost and 127.0.0.1 works but 0.0.0.0 may cause issues with CORS headers At this pont your folder structure should look like this: diff --git a/docs/gettingstarted/installation.md b/docs/gettingstarted/installation.md index 06a19456..6e6fe886 100644 --- a/docs/gettingstarted/installation.md +++ b/docs/gettingstarted/installation.md @@ -49,7 +49,7 @@ After twr-wasm is cloned, use VS Code `File | Open Folder`. [See here](https://github.com/twiddlingbits/twr-wasm/blob/main/examples/readme.md) for information on running the examples or building the examples. -[See here](../more/building.md) for information on building the source. +[See here](../more/building.md) for information on building the source and it's required dependencies. 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. diff --git a/docs/more/building.md b/docs/more/building.md index 8574eff3..a16dbf94 100644 --- a/docs/more/building.md +++ b/docs/more/building.md @@ -16,10 +16,10 @@ The `main` branch contains the latest release. The `dev` branch is work in prog ## Tools Needed to Build twr-wasm Source You will need these core tools, versions used in release are in (): -- TypeScript (5.4.5) +- TypeScript (5.4.5) - program is usually called tsc - clang tool chain (17.0.6) - for C/C++ code -- wasm-ld (17.0.6) - to link the .wasm files -- wat2wasm (1.0.34) - to compile WebAssembly (.wat) files of which I have a few +- wasm-ld (17.0.6) - to link the .wasm files (packaged as lld in linux) +- wat2wasm (1.0.34) - to compile WebAssembly (.wat) files of which I have a few (packaged as wabt in linux) - GNU make (4.4.1) - git - to clone twr-wasm source, or to clone llvm, if you want to build libc++ diff --git a/examples/readme.md b/examples/readme.md index f551e1d7..0aa98869 100644 --- a/examples/readme.md +++ b/examples/readme.md @@ -35,6 +35,8 @@ The examples will run without building using chrome and a file:// URL. The file - Ensure clang and wasm-ld are installed - Ensure a version of gnu make is installed (to use the Makefiles). - the examples use parcel v2 as a bundler + - Ensure typescript and wat2wasm are installed + - For the full list of dependencies see [Building From Source](https://twiddlingbits.dev/docsite/more/building/) - to run the examples on your local machine using the provided server script (server.py), you need to install python. This script sets certain CORS headers needed by SharedArrayBuffer, that are not usually set using other dev servers. ## Build and execute the examples with a local http server