fatalerrors/init.sh
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

README.md: updated and corrected documentation

Browse Source
This commit is contained in:
levasseur
2021-12-13 18:47:47 +01:00
parent fe4e61ce56
commit bbd35ee3c6
1 changed files with 23 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -16,8 +16,9 @@ using Debian GNU/Linux, Devuan and different flavors of Ubuntu.
- [4. Error code table](#4-error-code-table) - [4. Error code table](#4-error-code-table)
- [5. Contact and more information](#5-contact-and-more-information) - [5. Contact and more information](#5-contact-and-more-information)
- [5.1. New users](#51-new-users) - [5.1. New users](#51-new-users)
- [5.2. How to contribute?](#51-how-to-contribute) - [5.2. Bugs](#52-bugs)
- [5.3. Website and maintainor](#52-website-and-maintainor) - [5.3. How to contribute?](#53-how-to-contribute)
- [5.4. Website and maintainor](#54-website-and-maintainor)
## 1. Getting started ## 1. Getting started
You should consider reading that document entirely before use. If you need You should consider reading that document entirely before use. If you need
@@ -41,7 +42,7 @@ hardcoded monolitic scripts where I had to rewritte many things on every new
infrastructures I wanted to manage. As it was a fastidious job, I started to infrastructures I wanted to manage. As it was a fastidious job, I started to
rewritte and redesign everything with a common architecture and code, modular rewritte and redesign everything with a common architecture and code, modular
and easily adaptative. As I don't know any tools in that market scale, I decided and easily adaptative. As I don't know any tools in that market scale, I decided
to publish and share that work, in the hope I can be usefull. to publish and share that work, in the hope it can be usefull.
## 3. Design ## 3. Design
**init.sh** relies on three different elements to work: **init.sh** relies on three different elements to work:
@@ -308,7 +309,7 @@ The following table is giving a list of error code with explanation:
| Code | Meaning | | Code | Meaning |
|:----------|:------------------------------------------------------------| |:----------|:------------------------------------------------------------|
| 0 | No error | | 0 | No error |
| 1 | Command line syntax error | | 1 | Command line syntax error or incompatible options |
| 2 | Misuse of Bash built-in | | 2 | Misuse of Bash built-in |
| 3 | Missing library file or function | | 3 | Missing library file or function |
| 4 | No root rights | | 4 | No root rights |
@@ -324,6 +325,7 @@ The following table is giving a list of error code with explanation:
| 14 | Impossible to chroot | | 14 | Impossible to chroot |
| 15 | Bad chrooted installation, destination OS needs to be fixed | | 15 | Bad chrooted installation, destination OS needs to be fixed |
| 16 | Invalid options provided with cron mode activated | | 16 | Invalid options provided with cron mode activated |
| 17 | Missing or invalid status file, can't resume |
| 50..100 | Error in module execution | | 50..100 | Error in module execution |
| 126 | Command exists but is not executable | | 126 | Command exists but is not executable |
| 127 | Command not found | | 127 | Command not found |
@@ -336,13 +338,25 @@ you in the debugging process. If you find a bug outside modules or in the basic
provided module, please contact the author. Of course, if you also have a patch, provided module, please contact the author. Of course, if you also have a patch,
your mail will be even more welcomed! your mail will be even more welcomed!
You can check [error fixing documentation](./doc/errors.md) to obtain help on
how to solve problems.
## 5. Contact and more information ## 5. Contact and more information
### 5.1. New users ### 5.1. New users
As this project is very new and as I have no idea of who will use it, if you do As this project is very new and as I have no idea of who will use it, if you do
so, I'll be very happy if you simply mail me to let me know, especially if you so, I'll be very happy if you simply mail me to let me know, especially if you
don't plan to contribute. don't plan to contribute.
### 5.2. How to contribute? ### 5.2. Bugs
**init.sh** have no bug tracker yet. For now, if you find a bug, please submit a
bag report to the maintenor mentionned at the end of that document. A bug report
may contain the command line parameters where the bug happens, OS details,
the module that trigger it if any, and the log file containing the error.
Please check the to do list before sending any report as the problem might
already be known.
### 5.3. How to contribute?
You are free to improve and contribute as you wish. If you have no idea what to You are free to improve and contribute as you wish. If you have no idea what to
do or want some direction, you can check the [to do list](./doc/todo.md), do or want some direction, you can check the [to do list](./doc/todo.md),
containing desired future improvements. Make sure you always have the latest containing desired future improvements. Make sure you always have the latest
@@ -363,7 +377,9 @@ packages not provided in minimal Debian installation will be rejected. Anyway,
core scripts will remain in Bash whatever the evolutions of ```init.sh``` will core scripts will remain in Bash whatever the evolutions of ```init.sh``` will
be. be.
### 5.3. License, website and maintainor If you want to make a financial contribution, please contact me by mail.
### 5.4. License, website and maintainor
Everything except configuration files is licensed under BSD-3 license. Please Everything except configuration files is licensed under BSD-3 license. Please
check license file allong this one. check license file allong this one.
@@ -371,4 +387,4 @@ Please check [https://www.geoffray-levasseur.org/init](https://www.geoffray-leva
Please note that this website is still under construction and needs some more Please note that this website is still under construction and needs some more
care. care.
You can mail author to fatalerrors \<at\> geoffray-levasseur \<dot\> org You can mail author to fatalerrors \<at\> geoffray-levasseur \<dot\> org.