From 6b96fdc765371be62236ac0468529eb0ad4d1462 Mon Sep 17 00:00:00 2001 From: EuAndreh Date: Wed, 21 Jul 2021 10:39:29 -0300 Subject: README.md: Add dicrectory structure overview Implements #task-c140c4df-042e-6aa5-2202-c27e707d7eb4. --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0a900ea..be08c47 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit v1.2.3