]> Shamusworld >> Repos - init-ng/blobdiff - README
Added version which conforms to openrc coding guidelines.
[init-ng] / README
diff --git a/README b/README
index be745eb17e6f9a4c8a9036613928b549bd54986f..b4a95fc226bce88f612481839a19b69f511097af 100644 (file)
--- a/README
+++ b/README
@@ -5,32 +5,36 @@ RATIONALE
 ---------
 
 init-ng is meant to be a drop-in replacement for Sys V init. It leverages the
-mighty power of OpenRC to do only what's needed, and nothing more! It is still
-somewhat experimental (hence written in Ruby) but works well. Currently, it
-can reliably bring the system up, bring it down, and respawn agettys if they
-die.
+mighty power of OpenRC to do only what's needed, and nothing more! Currently,
+it can reliably bring the system up, bring it down three different ways, and
+respawn agettys if they die.
 
 init-ng can also be extended fairly easily as well; for those who want service
 supervision or socket activation, these can be fairly easily added. There is
 already some supervision capability built-in, as init-ng monitors the agettys
 that it spawns; this can be extended to other services as well.
 
-Note that while this init is written in Ruby, init-ng will eventually be
-written in C. It's being developed in Ruby in order to make development and
-testing easy.
-
 
 HOW TO INSTALL/USE IT
 ---------------------
 
- • Make sure you have Ruby 2.1.x installed.
+First, run 'make' to create the init-ng binary. Then, there are two main ways
+to install it. First way:
+
  • Move your current init binary out of the way (mv /sbin/init /sbin/init.sysv)
- • Copy the init script to /sbin (cp ./init /sbin/)
- • Make sure /sbin/init is marked executable (chmod ugo+x /sbin/init)
+ • Copy the init-ng binary to /sbin (cp ./init-ng /sbin/init)
+ • Reboot
+
+Second way:
+
+ • Copy the init-ng binary to /sbin (cp ./init-ng /sbin/)
+ • Add a kernel parameter with 'init=/sbin/init-ng' (without the quotes) to
+   your current kernel boot command line
  • Reboot
 
-Once you have rebooted successfully and logged in as root, typing 'init' on the
-command line will display the commands that init-ng understands.
+Once you have rebooted successfully and logged in as root, typing 'init' (or
+'init-ng', if you installed the second way) on the command line will display
+the commands that init-ng understands.
 
 
 CREDITS