Skip to content

Commit 44d9c07

Browse files
committed
small corrections
1 parent 3c0e6b6 commit 44d9c07

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ See examples/simple_image_wasm.html for details.
4242
2. Clone ARToolKit5 project to get the latest source files. From within jsartoolkit5 directory do `git submodule update --init`. If you already cloned ARToolKit5 to a different directory you can:
4343
- create a link in the `jsartoolkit5/emscripten/` directory that points to ARToolKit5 (`jsartoolkit5/emscripten/artoolkit5`) (Linux and macOS only)
4444
- or, set the `ARTOOLKIT5_ROOT` environment variable to point to your ARToolKit5 clone
45-
- or, change the `tools/makem.js` file to point to your artoolkit5 clone (line 62, 83, 107, 140)
45+
- or, change the `tools/makem.js` file to point to your artoolkit5 clone (line 20)
4646

4747
## Build Instructions
4848

@@ -57,7 +57,7 @@ See examples/simple_image_wasm.html for details.
5757
8. `docker rmi trzeci/emscripten-slim:latest` - remove the image if you don't need it anymore
5858
9. The build artefacts are in `/build`. There's a build with debug symbols in `artoolkit.debug.js` and the optimized build with bundled JS API in `artoolkit.min.js` and a WebAssembly build artoolkit_wasm.js and artoolkit_wasm.wasm
5959

60-
### !! Not recommended !! : Build local with manual emscripten setup
60+
### ⚠️ Not recommended ⚠️ : Build local with manual emscripten setup
6161
To prevent issues with Emscripten setup and to not have to maintain several build environments (macOS, Windows, Linux) we only maintain the **Build using Docker**. Following are the instructions of the last know build on Linux which we verified are working. **Use at own risk.**
6262
** Not working on macOS!**
6363

@@ -71,7 +71,7 @@ jsartoolkit5 aim is to create a Javascript version of artoolkit5. First, you nee
7171
2. Clone ARToolKit5 project to get the latest source files. From within jsartoolkit5 directory do `git submodule update --init`. If you already cloned ARToolKit5 to a different directory you can:
7272
- create a link in the `jsartoolkit5/emscripten/` directory that points to ARToolKit5 (`jsartoolkit5/emscripten/artoolkit5`)
7373
- or, set the `ARTOOLKIT5_ROOT` environment variable to point to your ARToolKit5 clone
74-
- or, change the `tools/makem.js` file to point to your artoolkit5 clone (line 62, 83, 107, 140)
74+
- or, change the `tools/makem.js` file to point to your artoolkit5 clone (line 20)
7575

7676
3. Building
7777
1. Make sure `EMSCRIPTEN` env variable is set (e.g. `EMSCRIPTEN=/usr/lib/emsdk_portable/emscripten/master/ node tools/makem.js`
@@ -82,15 +82,15 @@ During development, you can run ```npm run watch```, it will rebuild the library
8282

8383
4. The built ASM.js files are in `/build`. There's a build with debug symbols in `artoolkit.debug.js` and the optimized build with bundled JS API in `artoolkit.min.js`.
8484

85-
# ARToolKit JS API
85+
## ARToolKit JS API
8686

8787
```js
8888
<script src="../build/artoolkit.min.js">
8989
// include optimized ASM.js build and JS API
9090
</script>
9191
```
9292

93-
# ARToolKit JS debug build
93+
## ARToolKit JS debug build
9494

9595
```js
9696
<script async src="../build/artoolkit.debug.js">
@@ -101,7 +101,7 @@ During development, you can run ```npm run watch```, it will rebuild the library
101101
</script>
102102
```
103103

104-
# ARToolKit Three.js helper API
104+
## ARToolKit Three.js helper API
105105

106106
```js
107107
<script src="../build/artoolkit.min.js">
@@ -119,11 +119,11 @@ console.log("Three.js helper API loaded");
119119
};
120120
if (window.ARController && window.ARController.getUserMediaThreeScene) {
121121
ARThreeOnLoad();
122-
}
122+
};
123123
</script>
124124
```
125125

126-
# Examples
126+
## Examples
127127

128128
See `examples/` for examples on using the raw API and the Three.js helper API.
129129

0 commit comments

Comments
 (0)