Skip to content

Commit be60121

Browse files
committed
🐛 Fix dyne#93 updating documentation targets
1 parent bfedba5 commit be60121

File tree

4 files changed

+74
-23
lines changed

4 files changed

+74
-23
lines changed

Makefile

+6-4
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,13 @@ include ${pwd}/build/config.mk
3030
all:
3131
@echo "Choose a target:"
3232
@echo "- linux, linux-lib, linux-clang, linux-debug"
33-
@echo "- javascript-web, javascript-wasm, javascript-demo, etc. (need EMSDK)"
34-
@echo "- linux-python3, linux-go (language bindings)"
35-
@echo "- osx, osx-python3, ios-armv7, ios-arm64, ios-sim (need Apple/OSX)"
36-
@echo "- win, win-dll (cross-compile using MINGW on Linux)"
33+
@echo "- javascript-web, javascript-wasm, javascript-demo, javascript-rn etc. (need EMSDK)"
34+
@echo "- linux-python3, linux-go, osx-python3, osx-go (language bindings)"
35+
@echo "- osx, ios-lib, ios-armv7, ios-arm64, ios-sim (need Apple/OSX)"
36+
@echo "- win, win-dll (cross-compile using MINGW on Linux)"
3737
@echo "- musl, musl-local, musl-system (full static build)"
38+
@echo "- android-arm android-x86 android-aarch64"
39+
@echo "- cortex-arm, linux-riscv64, aarch64"
3840
@echo "for android and ios see scripts in build/"
3941

4042
# if ! [ -r build/luac ]; then ${gcc} -I${luasrc} -o build/luac ${luasrc}/luac.c ${luasrc}/liblua.a -lm; fi

docs/_media/css/style.css

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
--text-color-base: #2e2e46;
55
--text-color-secondary: #646473;
66
--text-color-tertiary: #81818e;
7+
--docsifytabs-border-color: #ededed;
8+
--docsifytabs-tab-highlight-color: var(--theme-color);
79
}
810

911
body {

docs/index.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,6 @@
147147
.replace(/name = "/gi, `id = "`)
148148
.replace(`<li><a href="index.html">Index</a></li>`,
149149
`<li><a href="/#/pages/ldoc/o/README.md">Index</a></li>`)
150-
console.log(html)
151150
}
152151
next(html)
153152

@@ -205,6 +204,8 @@
205204
<script src="//cdn.jsdelivr.net/gh/pcooksey/bibtex-js/src/bibtex_js.js"></script>
206205
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/external-script.min.js"></script>
207206
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/ga.min.js"></script>
207+
<script src="//cdn.jsdelivr.net/npm/docsify-tabs@1"></script>
208+
208209

209210
<script src="//unpkg.com/prismjs/components/prism-json.min.js"></script>
210211
<script src="//unpkg.com/prismjs/components/prism-c.min.js"></script>

docs/pages/how-to-build.md

+64-18
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,66 @@ The Zenroom compiles the same sourcecode to run on Linux in the form of 2 differ
1111
5. `make javascript-demo` creates in the `docs/demo` folder a simple web page with a REPL and some boilerplate code to show how to use the WebAssembly binary (visible online [here](https://zenroom.dyne.org/demo))
1212

1313
Remember that if after cloning this source code from git, one should do:
14-
```
14+
```bash
1515
git submodule update --init --recursive
1616
```
1717

18-
Then first build the shared executable environment:
18+
Then first build the shared executable for your platform:
19+
20+
<!-- tabs:start -->
21+
22+
#### ** Linux **
23+
24+
```bash
25+
make linux
26+
```
27+
28+
#### ** macOS **
29+
30+
```bash
31+
make osx
32+
```
33+
34+
#### ** Windows **
1935

36+
```bash
37+
make win
2038
```
21-
make shared
39+
40+
#### ** BSD **
41+
```bash
42+
make bsd
2243
```
44+
45+
<!-- tabs:end -->
46+
47+
2348
To run tests:
2449

50+
<!-- tabs:start -->
51+
52+
#### ** Functional **
53+
54+
```bash
55+
make check-osx
56+
make check-linux
2557
```
26-
make check-shared
58+
59+
#### ** Integration **
60+
61+
```bash
62+
make check-js
63+
make check-py
64+
```
65+
66+
#### **Crypto**
67+
```bash
68+
make check-crypto
69+
make check-crypto-lw
2770
```
2871

72+
<!-- tabs:end -->
73+
2974
To build the static environment:
3075

3176
```
@@ -34,19 +79,24 @@ make static
3479
make check-static
3580
```
3681

37-
For the Javascript and WebAssembly modules the Zenroom provides various targets provided by emscripten which must be installed and loaded in the environment according to the emsdk's instructions :
82+
For the Javascript and WebAssembly modules the Zenroom provides various targets provided by emscripten which must be installed and loaded in the environment according to the emsdk's instructions and linked inside the `build` directory of zenroom sources:
3883

84+
```bash
85+
make javascript-wasm # For the webassembly build node/web
86+
make javascript-rn # For react native
3987
```
40-
make javascript-node
41-
make javascript-wasm
88+
89+
There is another target to create the [`playground`](https://dev.zenroom.org/demo/) locally
90+
91+
!> for the `javascript-demo` target the generated files should be served by a http server
92+
93+
```bash
4294
make javascript-demo
95+
cd docs
96+
make preview
4397
```
44-
NB. for the `javascript-demo` target the generated files should be served by a http server and not directly opened in a browser eg.
45-
```
46-
$ make javascript-demo
47-
$ cd docs/demo
48-
$ python3 -m http.server
49-
```
98+
99+
then point your browser to http://localhost:3000/demo
50100

51101
# Build instructions for Mobile libraries
52102

@@ -81,8 +131,4 @@ src/
81131
libzenroom.so
82132
armeabi/
83133
libzenroom.so
84-
```
85-
86-
87-
88-
134+
```

0 commit comments

Comments
 (0)