Unverified Commit 20374aff authored by Stephan Lachnit's avatar Stephan Lachnit
Browse files

doc: add note about doc/README.md 



Signed-off-by: default avatarStephan Lachnit <stephanlachnit@debian.org>
parent 7e523139

doc/usermanual/10_development/03_new_module.md

+2 −0
Original line number Diff line number Diff line
@@ -159,6 +159,8 @@ and should contain at least the following sections: 
- An H2-size section with the title **Usage** which should contain at least one simple example of a valid configuration for

  the module.



For advances features in GLFM such as citations and formulae, see `doc/README.md` in the project repository \[[@ap2-repo]\].



### `<ModuleName>Module.hpp` and `<ModuleName>Module.cpp`



All modules should consist of both a header file and a source file. In the header file, the module is defined together with

doc/usermanual/11_devtools/04_deployment.md

+2 −0
Original line number Diff line number Diff line
@@ -53,6 +53,8 @@ If a new tag is pushed to the project repository, the CI in the project reposito 
repository. This pipeline clones the project repository to get the Markdown documentation, generates the HTML with hugo and

deploys it. This setup allows to update information on the website without pushing a new tag to the project repository.



For more information on the documentation, see `doc/README.md` in the project repository \[[@ap2-repo]\].





[@cvmfs]: https://pos.sissa.it/070/052/

[@ap2-repo]: https://gitlab.cern.ch/allpix-squared/allpix-squared