MaksymPrymierov / Conix-Core

GNU General Public License v3.0
5 stars 1 forks source link

<wiki> Start working on this wiki project #6

Closed MaksymPrymierov closed 3 years ago

MaksymPrymierov commented 5 years ago

Create a wiki for the code. Create how-to for building the project. Create a wiki for application technology in the project.

s-kostyuk commented 5 years ago

In case you are interested I can recommend the Read the Docs service hosted at https://rtfd.io/. It's free to use, it supports the reStructuredText format and allows to create a very comprehensive and good-styled documentation. For example, I use Read the Docs for my Python-based everpl project: https://everpl.readthedocs.io/en/latest/. Linux kernel projects also uses RST file format and a Sphinx-based service: https://www.kernel.org/doc/html/v4.10/doc-guide/sphinx.html.

Or, maybe, the Doxygen will be a better fit for this project.