From 48bcf61c6eebdacfa7db6624b2a3e2cfc526999b Mon Sep 17 00:00:00 2001 From: Michael Boelen Date: Mon, 14 Sep 2015 13:18:44 +0200 Subject: [PATCH] Updated Developer Guide (markdown) --- Developer-Guide.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/Developer-Guide.md b/Developer-Guide.md index 1652d98..b98275b 100644 --- a/Developer-Guide.md +++ b/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.