diff options
| author | EuAndreh <eu@euandre.org> | 2021-07-21 10:39:29 -0300 |
|---|---|---|
| committer | EuAndreh <eu@euandre.org> | 2021-07-21 10:39:29 -0300 |
| commit | 6b96fdc765371be62236ac0468529eb0ad4d1462 (patch) | |
| tree | 314ed0e23755edae8e5168afe279eb193d7d78bc /README.md | |
| parent | TODOs.md: Add #task-c140c4df-042e-6aa5-2202-c27e707d7eb4 (diff) | |
| download | git-permalink-6b96fdc765371be62236ac0468529eb0ad4d1462.tar.gz git-permalink-6b96fdc765371be62236ac0468529eb0ad4d1462.tar.xz | |
README.md: Add dicrectory structure overview
Implements #task-c140c4df-042e-6aa5-2202-c27e707d7eb4.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 15 insertions, 1 deletions
@@ -60,13 +60,27 @@ There are no dependencies or requirements, only standard tools such as ## Documentation -The documentation is available via installed manpages or online: [`git-permalink.1`] ([pt][pt2], [fr][fr2], [eo][eo2]). +### Manuals + +The documentation is available via installed manpages or online: +- [`git-permalink.1`] ([pt][pt2], [fr][fr2], [eo][eo2]). [`git-permalink.1`]: https://euandreh.xyz/git-permalink/en/git-permalink.1.html [pt2]: https://euandreh.xyz/git-permalink/pt/git-permalink.1.html [fr2]: https://euandreh.xyz/git-permalink/fr/git-permalink.1.html [eo2]: https://euandreh.xyz/git-permalink/eo/git-permalink.1.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 |