update readme

2024-10-15 16:51:50 +02:00
parent 3fcd2191ee
commit d907165ff1
1 changed files with 3 additions and 0 deletions
@@ -17,6 +17,9 @@ These docs are hosted at [nymtech.net/docs](www.nymtech.net/docs).
 * There are several autogenerated command files for clients and binaries. These are generated with `generate:commands`, which runs the `autodoc` rust binary, moves the files to their required places, and then if there is an update, commits them to git. This is for remote deployments.
 * TODO

+### Autodoc
+`autodoc` is a script that generates markdown files containing commands and their output (both command and `--help` output). For the moment the binaries and their commands are manually configured in the script.
+
 ## CI/CD
 TODO