diff options
author | Matthias Beyer <mail@beyermatthias.de> | 2016-10-27 11:21:22 +0200 |
---|---|---|
committer | Matthias Beyer <mail@beyermatthias.de> | 2016-10-27 16:40:29 +0200 |
commit | e94c77f6e4673319a80f44d1f9ef6059a6ab1edc (patch) | |
tree | 16e4618b2de7a0c744a35a30587c56f8f4da982c /README.md | |
parent | 256f6efcf0ab4e5f7a8e710bd46ed701a770b2b9 (diff) |
Rewrite "Documentation"
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 13 |
1 files changed, 7 insertions, 6 deletions
@@ -97,15 +97,16 @@ and submit them to [this-week-in-rust](https://this-week-in-rust.org/). ## Documentation -For detailed information, please read [the documentation](./doc/). -You can either read the Markdown files or compile it to HTML/PDF using -[pandoc](http://pandoc.org). +This is a hobby project, so sometimes things are not optimal and might go +unrecognized and slip through. Feel free to open issues about things you notice! + +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 [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! We are looking for contributors! |