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 2016-01-27 13:57:05 +01:00
parent f5b60b259d
commit 44778f2cf9
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Developer-Guide.md

@ -1,18 +1,19 @@
# Getting Started
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.
Doing developing on Lynis is easy. Our tool is written in shell script. It uses the Bourne shell, usually /bin/sh on your system. Don't confuse it with BASH though, the Bourne Again SHell. By adhering to the Bourne shell the tool remains portable, running on Linux, *BSD, Mac OS X, and others.
# Structure
The first part when developing, is understanding the structure of the project.
Understanding the structure of the project is an important starting point
## Directories
In the tarball and on GitHub, you will see just a few 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.
The most important files, like the Lynis script itself, can be found in the root of the directory. It will include other things like the man page, documentation and changelog.
### 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.
The directory is named "include", as more intelligence is included (or sourced) by the main script. This way it can import functions, initialize variables, and show the report. Also the individual tests are stored in this directory. They are grouped by category. This directory is definitely where most of the magic happens.
### Extra directory
Supporting documents and scripts are stored here.
@ -27,7 +28,7 @@ Like any programming language, there are different ways to keep a project struct
# Contribute
First step to contributing via GitHub, is by forking the project. This creates a local version for you to experiment.
First step to contributing via GitHub, is by [forking](https://help.github.com/articles/fork-a-repo/) the project. This creates a local version for you to experiment.
* Fork it ( https://github.com/CISOfy/lynis/fork )
* Create your feature branch (git checkout -b adding-my-new-feature)