Change template docs

This commit is contained in:
redfast00 2022-02-01 08:05:56 +01:00
parent e7eea065bf
commit 7fc9dbdc5f
No known key found for this signature in database
GPG key ID: 5946E0E34FD0553C

View file

@ -1,19 +1,20 @@
## {MODULE_NAME}
# {MODULE_NAME}
Write the defusing guide for your module here. For inspiration, look at the documentation of
existing modules.
Schrijf de handleiding voor je module hier. Kijk gerust naar de handleiding
voor de "Doolhof"-module (`src/modules/puzzle_maze/doc/index.md`)
Use drawings! Put them in the same directory as this file and include them like this:
![](filename.pdf)
Hieronder wat voorbeelden van markup die je kan gebruiken. Daarnaast kan je ook LaTeX
gebruiken (zie bijvoorbeeld de "Doolhof"-module)
Use drawings! Create the docs/images/your_module directory, put your image there and include them like this:
![](./your_module/filename.png)
Use tables! Write them like this:
| Symbol | Action to take |
|------------------|----------------|
| ![](symbol1.pdf) | Do nothing |
| ![](symbol2.pdf) | Press the red button |
| ![](symbol3.pdf) | Press the yellow button |
### Credits
Module developed by {AUTHOR}.
| Symbol | Action to take |
|--------------------------------|----------------|
| ![](./your_module/symbol1.png) | Do nothing |
| ![](./your_module/symbol2.png) | Press the red button |
| ![](./your_module/symbol3.png) | Press the yellow button |