From 4ee948ea41020b80b773509890f6631fd4960004 Mon Sep 17 00:00:00 2001 From: namilsk Date: Wed, 31 Dec 2025 23:09:33 +0300 Subject: Added logs annotation to `README.md` --- README.md | 42 ++++++++++++++++++++++++------------------ 1 file changed, 24 insertions(+), 18 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index eb1b156..820e3dd 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,24 @@ -# Vigil -Vigil is an init system (PID 1) developed for the Antrhill distribution and licensed under GPL2.0-only. - -The development is based on the Unix philosophy: -- **"Make each program do one thing well."** - - Doug McIlroy - -- **"Write programs that do one thing and do it well. Write programs to work together."** - - Peter H. Salus, summarizing Unix philosophy - -- **"The UNIX system is characterized by: [...] A unified view of I/O, and a hierarchical file system. A small number of kernel primitives, augmented by a rich set of user-level tools."** - - Ritchie & Thompson, «The UNIX Time-Sharing System» - -`vegil` strives to be indestructible, something that even in the case of most errors will boot you into the system. If not, then go to rescue mode with all the tools installed. - -# Development -This repo contains the source code of the `init` executable itself and `vegilctl`, for managing the initialization system. -At the moment, the init binary itself is a priority for development. \ No newline at end of file +# Vigil +Vigil is an init system (PID 1) developed for the Antrhill distribution and licensed under GPL2.0-only. + +The development is based on the Unix philosophy: +- **"Make each program do one thing well."** + - Doug McIlroy + +- **"Write programs that do one thing and do it well. Write programs to work together."** + - Peter H. Salus, summarizing Unix philosophy + +- **"The UNIX system is characterized by: [...] A unified view of I/O, and a hierarchical file system. A small number of kernel primitives, augmented by a rich set of user-level tools."** + - Ritchie & Thompson, «The UNIX Time-Sharing System» + +`vegil` strives to be indestructible, something that even in the case of most errors will boot you into the system. If not, then go to rescue mode with all the tools installed. + +# Development +This repo contains the source code of the `init` executable itself and `vegilctl`, for managing the initialization system. +At the moment, the init binary itself is a priority for development. + +# Usage +All operations are logged and start with `*` and looks like `* `, it has three colors: +- Red (`\x1b[31m`) - This means that a mission-critical operation has failed, and you will most likely go into rescue mode. +- Yellow (`\x1b[33m`) - It means that the operation specified by the user in the configuration or not critical has failed, the system will start, but it is better to pay attention to this. +- Green (`\x1b[32m`) - Everything is in order. \ No newline at end of file -- cgit v1.2.3