references/openproject
1
0
Fork 0
mirror of https://github.com/opf/openproject.git synced 2026-06-14 03:30:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

add a README-file for the doc subdirectory

Browse Source
This commit is contained in:
Jan Sandbrink
2014-10-02 15:38:10 +02:00
parent 12d8f452d6
commit 8d535a4e12
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/README.md
+13
View File
@@ -0,0 +1,13 @@
Documentation
=======================
About the APIv3 Documentation
-----------------------------
The documentation for APIv3 is written in the [API Blueprint Format](http://apiblueprint.org/).
You can use [aglio](https://github.com/danielgtaylor/aglio) to generate HTML documentation, e.g. using the following command:
```bash
aglio -i apiary.apib -o api.html
```