move setting the "systemdutildir" variable before it's used

[thirdparty/dracut.git] / README

diff --git a/README b/README
index f55f5a33c747ce462d1f1a4032a6ad7de8c1a9e3..ff374af864d2d3eeb331446daf711c074e8e7485 100644 (file)
--- a/README
+++ b/README
@@ -1,9 +1,10 @@
-Dracut
+dracut
 ------
-Dracut is a new initramfs infrastructure.
+dracut is an event driven initramfs infrastructure.
 
-Information about the initial goals and aims can be found at
-https://fedoraproject.org/wiki/Initrdrewrite
+dracut (the tool) is used to create an initramfs image by copying tools
+and files from an installed system and combining it with the
+dracut framework, usually found in /usr/lib/dracut/modules.d.
 
 Unlike existing initramfs's, this is an attempt at having as little as
 possible hard-coded into the initramfs as possible.  The initramfs has
@@ -19,19 +20,19 @@ we'll grow some hooks for running arbitrary commands in the flow of
 the script, but it's worth trying to resist the urge as much as we can
 as hooks are guaranteed to be the path to slow-down.
 
-Most of the initrd generation functionality in dracut is provided by a bunch
+Most of the initramfs generation functionality in dracut is provided by a bunch
 of generator modules that are sourced by the main dracut script to install
-specific functionality into the initrd.  They live in the modules.d
+specific functionality into the initramfs.  They live in the modules.d
 subdirectory, and use functionality provided by dracut-functions to do their
 work.
 
 Some general rules for writing modules:
  * Use one of the inst family of functions to actually install files
-   on to the initrd.  They handle mangling the pathnames and (for binaries,
+   on to the initramfs.  They handle mangling the pathnames and (for binaries,
    scripts, and kernel modules) installing dependencies as appropriate so
    you do not have to.
- * Scripts that end up on the initrd should be POSIX compliant. dracut
-   will try to use /bin/dash as /bin/sh for the initrd if it is available,
+ * Scripts that end up on the initramfs should be POSIX compliant. dracut
+   will try to use /bin/dash as /bin/sh for the initramfs if it is available,
    so you should install it on your system -- dash aims for strict POSIX
    compliance to the extent possible.
  * Hooks MUST be POSIX compliant -- they are sourced by the init script,
@@ -51,7 +52,7 @@ possible.  Every distribution has their own tool here and it's not
 something which is really interesting to have separate across them.
 So contributions to help decrease the distro-dependencies are welcome.
 
-Currently dracut lives on kernel.org.
+Currently dracut lives on github.com and kernel.org.
 
 The tarballs can be found here:
        http://www.kernel.org/pub/linux/utils/boot/dracut/
@@ -62,13 +63,14 @@ Git:
        http://git.kernel.org/pub/scm/boot/dracut/dracut.git
        https://git.kernel.org/pub/scm/boot/dracut/dracut.git
 
+       git@github.com:dracutdevs/dracut.git
+
 Git Web:
-       http://git.kernel.org/?p=boot/dracut/dracut.git
+       https://github.com/dracutdevs/dracut.git
 
-Git Web RSS Feed:
-       http://git.kernel.org/?p=boot/dracut/dracut.git;a=rss
+        http://git.kernel.org/?p=boot/dracut/dracut.git
 
-Project Page:
+Project Documentation:
        http://www.kernel.org/pub/linux/utils/boot/dracut/dracut.html
 
 Project Wiki: