diff options
author | Sebastien Douheret <sebastien.douheret@iot.bzh> | 2018-09-20 08:34:53 +0200 |
---|---|---|
committer | Sebastien Douheret <sebastien.douheret@iot.bzh> | 2018-09-20 09:50:50 +0200 |
commit | 390745b93c5f4af9b148c94433f44ec462a39770 (patch) | |
tree | 0e66007ef7f42b2cd46dc8a24dbc0f8237f894b0 /README.md | |
parent | 3e6d3fa8be349b40d6fd03d198b5e033cc7719e2 (diff) |
doc: Changed doc to new formatguppy_6.90.0guppy/6.90.06.90.0
- split book.json to match new format
- changed description in README.md
- remove useless files
Change-Id: Ie41edb058cf7cfc4920c5c84767097c4e46d34cb
Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 48 |
1 files changed, 0 insertions, 48 deletions
@@ -14,51 +14,3 @@ Just use autobuild script: ``` This will build both projects under build directory for each of them with default configuration. - -# Generate documentation - -## Prerequisites - -You can use gitbook to serve documentation. To do so, please install it using *npm* as well as *calibre* package from your package distribution manager: - -```bash -sudo npm install -g gitbook-cli -sudo apt-get install calibre -``` - -To generate Doxygen documentation, you'll need doxygen and graphviz: - -```bash -sudo apt-get install doxygen graphviz -``` - -Prepare your build environment: - -```bash -mkdir build && cd build -cmake .. -``` - -## Generation - -Generate a PDF version : - -```bash -gendocs.sh pdf -``` - -Serve an HTML version, this will run a web server that will serve you locally documentation : - -```bash -gendocs.sh serve -``` - -Generate doxygen documentation: - -```bash -gendocs.sh doxygen -``` -or -```bash -cd build && make doxygen -``` |