diff options
| author | EuAndreh <eu@euandre.org> | 2021-09-02 09:08:49 -0300 |
|---|---|---|
| committer | EuAndreh <eu@euandre.org> | 2021-09-02 09:08:49 -0300 |
| commit | e76a6276c4022eabb8ecbdb22184f3a22716f522 (patch) | |
| tree | 071e02d0635a8534301844184f2294547b2f4bbe /README.md | |
| parent | CHANGELOG.md: Point to english version URL (diff) | |
| download | remembering-e76a6276c4022eabb8ecbdb22184f3a22716f522.tar.gz remembering-e76a6276c4022eabb8ecbdb22184f3a22716f522.tar.xz | |
README.md: Add directory structure section to Documentation
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 16 insertions, 1 deletions
@@ -45,7 +45,11 @@ environment (`_POSIX_C_SOURCE 200809L`). ## Documentation -The documentation is available via installed manpages or online: [`remembering.1`] ([pt][pt.1], [fr][fr.1], [eo][eo.1]) and [`remembering.5`] ([pt][pt.5], [fr][fr.5], [eo][eo.5]). +### Manuals + +The documentation is available via installed manpages or online: +- [`remembering.1`] ([pt][pt.1], [fr][fr.1], [eo][eo.1]); +- [`remembering.5`] ([pt][pt.5], [fr][fr.5], [eo][eo.5]). [`remembering.1`]: https://euandreh.xyz/remembering/en/remembering.1.html [pt.1]: https://euandreh.xyz/remembering/pt/remembering.1.html @@ -56,6 +60,17 @@ The documentation is available via installed manpages or online: [`remembering.1 [fr.5]: https://euandreh.xyz/remembering/fr/remembering.5.html [eo.5]: https://euandreh.xyz/remembering/eo/remembering.5.html +### Directory structure + +The directory structure of the repository is: +- `aux/`: personal scripts and helpers I've vendored in to ensure the + repository is self contained, feel free to ignore it; +- `doc/`: manpages, with their translated versions; +- `po/`: gettext `.po` files for the translated languages and hunspell + dictionaries for spell checking; +- `src/`: main source code for the project; +- `tests/`: integration tests for the project. + ## Contributing |