diff options
| author | Ulf Lilleengen <[email protected]> | 2024-05-18 10:22:33 +0200 |
|---|---|---|
| committer | Ulf Lilleengen <[email protected]> | 2024-05-21 10:05:21 +0200 |
| commit | 2991099daa5b1cfbc7b67f358497ec4821c71a53 (patch) | |
| tree | 979ca89f6580365fcff0f6c65587480cdf7d9cd6 /docs/README.md | |
| parent | 739e5861c2e47db251725163fcd91cd822cf97b7 (diff) | |
move images and add makefile
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/README.md b/docs/README.md index 8b9a3c48d..94ebd7a05 100644 --- a/docs/README.md +++ b/docs/README.md | |||
| @@ -1,9 +1,9 @@ | |||
| 1 | # embassy docs | 1 | # embassy docs |
| 2 | 2 | ||
| 3 | The documentation hosted at [https://embassy.dev/book](https://embassy.dev/book). Building the documentation requires the [asciidoctor](https://asciidoctor.org/) tool, and can be built like this: | 3 | The documentation hosted at [https://embassy.dev/book](https://embassy.dev/book). Building the documentation requires the [asciidoctor](https://asciidoctor.org/) tool, and can built running `make` in this folder: |
| 4 | 4 | ||
| 5 | ``` | 5 | ``` |
| 6 | asciidoctor -d book -D thebook/ index.adoc | 6 | make |
| 7 | ``` | 7 | ``` |
| 8 | 8 | ||
| 9 | Then open the generated file `thebook/index.html`. | 9 | Then open the generated file `thebook/index.html`. |