started basic documentation, help in main program
This commit is contained in:
16
README.md.backup
Normal file
16
README.md.backup
Normal file
@@ -0,0 +1,16 @@
|
||||
# init.sh
|
||||
**init.sh** is an automated configurator for system administrator. It's fully written using Bash scripting and aims to be platform independent. Nevertheless it's requirements turns it naturally to Linux systems. It have long been tested using Debian GNU/Linux, Devuan and different flavor of Ubuntu.
|
||||
|
||||
## Getting started
|
||||
You should consider reading the Beginners guide. If you need to create additional modules to meet your needs, consider reading the Developers guide.
|
||||
|
||||
Please also consider that your needs might meet the needs of someone else, thus it would be a good idea to submit your module to init.sh source base.
|
||||
|
||||
## Design
|
||||
**init.sh** relies on three different elements to work:
|
||||
|
||||
- the init.sh script, which provide a simple framework and libraries to do simple taks and embed system dependent functions to provide system independent function calls.
|
||||
- modules that actually do the job on a system independant way through the use of the framework and consisting on very small and simple task.
|
||||
- multilevel configuration files, being just Bash variables declaration.
|
||||
|
||||
Additionally some module might be ran regularly so it could be integrated to a cron-like service.
|
||||
Reference in New Issue
Block a user