Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mschoema committed Oct 4, 2023
1 parent d22b8fc commit 44bd2f4
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ of the modules.

## Documentation

You can generate the workshop documentation from the sources. Go to `/doc` directory and run:
You can generate the workshop documentation from the sources. Go to `/docs` directory and run:
* In HTML format
```bash
xsltproc --stringparam html.stylesheet "docbook.css" --xinclude -o index.html /usr/share/xml/docbook/stylesheet/docbook-xsl/html/chunk.xsl mobilitydb-workshop.xml
xsltproc --stringparam html.stylesheet "docbook.css" --stringparam chunker.output.encoding "UTF-8" --xinclude -o index.html /usr/share/xml/docbook/stylesheet/docbook-xsl/html/chunk.xsl mobilitydb-workshop.xml
```
* In PDF format
```bash
Expand All @@ -21,13 +21,21 @@ You can generate the workshop documentation from the sources. Go to `/doc` direc
```
In addition, pre-generated versions of them are available.

* In HTML format: https://docs.mobilitydb.com/MobilityDB-workshop/master/
* In PDF format: https://docs.mobilitydb.com/MobilityDB-workshop/master/mobilitydb-workshop.pdf
* In EPUB format: https://docs.mobilitydb.com/MobilityDB-workshop/master/mobilitydb-workshop.epub
Master branch:

* In HTML format: https://mobilitydb.github.io/MobilityDB-workshop/master/index.md
* In PDF format: https://mobilitydb.github.io/MobilityDB-workshop/master/mobilitydb-workshop.pdf
* In EPUB format: https://mobilitydb.github.io/MobilityDB-workshop/master/mobilitydb-workshop.epub

Develop branch:

* In HTML format: https://mobilitydb.github.io/MobilityDB-workshop/develop/index.md
* In PDF format: https://mobilitydb.github.io/MobilityDB-workshop/develop/mobilitydb-workshop.pdf
* In EPUB format: https://mobilitydb.github.io/MobilityDB-workshop/develop/mobilitydb-workshop.epub

## How the Repo is Organized
- `/data`: raw data files used for some workshops
- `/doc`: files needed to generate the workshop documentation from sources
- `/docs`: files needed to generate the workshop documentation from sources

## Docker container

Expand Down

0 comments on commit 44bd2f4

Please sign in to comment.