summaryrefslogtreecommitdiffstats
path: root/agl-documentation/README.md
blob: bf38bb281facd903fb61c09840da027d7c21dd33 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# SDK devkit

This repository holds AGL documentation (written by the IoT.bzh team) which is
 not yet merged into official AGL repository.

## How to generate pdf

Documentation is based on [gitbook](https://www.gitbook.com/).
To install locally gitbook:

```bash
npm install -g gitbook-cli
```

To generate documentation:

```bash
./gen_all_docs.sh
```

or to generate one individual doc manually:
You must install calibre first :

```bash
sudo apt install calibre
```

```bash
gitbook pdf ./sdk-devkit ./build/sdk-devkit.pdf
```

## Notes / TODO

* Add Iot.Bzh logo in header instead of IoT.Bzh text
* Write a plugin based on svg + convert to generate cover.