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:14 +02:00
parent 1668b0c472
commit 00b3fa5a3b
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
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