tyler.durden/lynis
1
0
Fork 0
mirror of https://github.com/CISOfy/lynis.git synced 2025-07-31 01:34:23 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated Developer Guide (markdown)

Michael Boelen 2015-09-14 13:18:44 +02:00
parent 00b3fa5a3b
commit 48bcf61c6e
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Developer-Guide.md

@ -6,13 +6,15 @@ Developing is not that hard, as our tool is written in shell script. It uses Bou
The first part when developing, is understanding the structure of the project.
## Root directory
## Directories
### Root directory
The most important files, like the Lynis script can be found in the root of the directory, together with the man page and documentation.
## Include directory
### Include directory
The directory is named "include", as more intelligence is included (or sourced) by the main script. It includes important functions, initializes variables, and shows the report. Also the individual tests are stored in this directory. So this directory is definitely where most of the magic happens.
## Extra directory
### Extra directory
Supporting documents and scripts are stored here.