matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

Rewrite "Documentation"

Browse source
This commit is contained in:
Matthias Beyer 2016-10-27 11:21:22 +02:00
parent 256f6efcf0
commit e94c77f6e4
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -97,15 +97,16 @@ and submit them to [this-week-in-rust](https://this-week-in-rust.org/).
## Documentation ## Documentation
For detailed information, please read [the documentation](./doc/). This is a hobby project, so sometimes things are not optimal and might go
You can either read the Markdown files or compile it to HTML/PDF using unrecognized and slip through. Feel free to open issues about things you notice!
[pandoc](http://pandoc.org).
Though, we have some documentation in [the ./doc subtree](./doc/)
which can be compiled to PDF or a website.
These docs are not published anywhere and are not even integrated into our CI,
so it might be broken (though it's unlikely).
Developer documentation is also available Developer documentation is also available
[online on github.io](https://matthiasbeyer.github.io/imag/imag_documentation/index.html). [online on github.io](https://matthiasbeyer.github.io/imag/imag_documentation/index.html).
Please note that the documentation is work in progress as well and may be
outdated.
## Please contribute! ## Please contribute!
We are looking for contributors! We are looking for contributors!