From 00b3fa5a3b3188cd55bd1b3dd6c11b7879329340 Mon Sep 17 00:00:00 2001 From: Michael Boelen Date: Mon, 14 Sep 2015 13:18:14 +0200 Subject: [PATCH] Updated Developer Guide (markdown) --- Developer-Guide.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/Developer-Guide.md b/Developer-Guide.md index cfe1196..1652d98 100644 --- a/Developer-Guide.md +++ b/Developer-Guide.md @@ -1,8 +1,20 @@ # Getting Started -Developing is not that hard, as our project is written in shell script. +Developing is not that hard, as our tool is written in shell script. It uses Bourne shell (not to be confused with Bourne again shell, or BASH). The benefit is that it is available to all UNIX based systems, and a common language to every system administrator. No deep programming language is needed to be able to contribute. # Structure +The first part when developing, is understanding the structure of the project. + +## 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 +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 +Supporting documents and scripts are stored here. + + # Style \ No newline at end of file