mrtoth/baseimage-tutorial-framework
1
0
Fork 0
mirror of https://github.com/avatao-content/baseimage-tutorial-framework synced 2025-11-04 00:42:55 +00:00
Code Issues Releases Wiki Activity

Include new docs building method in readme

Browse Source
This commit is contained in:
Kristóf Tóth
2018-06-08 14:15:44 +02:00
parent 24780a9285
commit 2fc54832f3
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -80,6 +80,6 @@ The TFW message format:
Most of the components you need have docstrings included (hang on tight, this is work in progress) – refer to them for usage info. Most of the components you need have docstrings included (hang on tight, this is work in progress) – refer to them for usage info.
In the `docs` folder you can find our Sphinx-based API documentation, which you can build using the included `Makefile` (you need to have Sphinx installed, please reach out to us if you have trouble building the docs). In the `docs` folder you can find our Sphinx-based API documentation, which you can build using the `hack/tfw.sh` script in the [test-tutorial-framework](https://github.com/avatao-content/test-tutorial-framework) repository.
To get started you should take a look at the [test-tutorial-framework](https://github.com/avatao-content/test-tutorial-framework) repository, which serves as an example project as well. To get started you should take a look at [test-tutorial-framework](https://github.com/avatao-content/test-tutorial-framework), which serves as an example project as well.