X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=README;h=3b248048cc557a7268032d43cec983883c505cc6;hb=d970bd6d39f808b29a804050747c0883fcc2784b;hp=07fa162bbd87d6f26e561f51b59d3fe4bac76d1e;hpb=cee360d32efd8392f7e342dcaeda1de50a2c1bcf;p=elogind.git

diff --git a/README b/README
index 07fa162bb..3b248048c 100644
--- a/README
+++ b/README
@@ -1,37 +1,120 @@
+systemd System and Service Manager
 
-udev - a userspace implementation of devfs
+DETAILS:
+        http://0pointer.de/blog/projects/systemd.html
 
-For more information on the design, and structure of this project, see the
-files in the docs/ directory.
+WEB SITE:
+        http://www.freedesktop.org/wiki/Software/systemd
 
-To use:
+GIT:
+        git://anongit.freedesktop.org/systemd/systemd
+        ssh://git.freedesktop.org/git/systemd/systemd
 
-- Edit the udev.h file and replace the following variables with values
-  that make sense for your system:
-	#define UDEV_ROOT       "/udev/"
-	#define MKNOD           "/bin/mknod"
-  The only value most people will have to change is the UDEV_ROOT
-  variable, as I doubt you really want device nodes to be created in my
-  home directory :)
+GITWEB:
+        http://cgit.freedesktop.org/systemd/systemd
 
-- Run make to build the project.
+MAILING LIST:
+        http://lists.freedesktop.org/mailman/listinfo/systemd-devel
+        http://lists.freedesktop.org/mailman/listinfo/systemd-commits
 
-- Make sure sysfs is mounted.
+IRC:
+        #systemd on irc.freenode.org
 
-- Point /proc/sys/kernel/hotplug at the location of the udev binary that
-  is created.  Then plug some block devices in, or other types of
-  devices that create dev files in sysfs.  An easy way to do this,
-  without any hardware is to use the scsi_debug module to create virtual
-  scsi devices.
+BUG REPORTS:
+        https://bugs.freedesktop.org/enter_bug.cgi?product=systemd
 
-- Watch as the nodes get created and removed.
+AUTHOR:
+        Lennart Poettering
+        Kay Sievers
+        ...and many others
 
+LICENSE:
+        LGPLv2.1+ for all code
+        - except sd-daemon.[ch] and sd-readahead.[ch] which are MIT
+        - except src/udev/ which is GPLv2.0+
 
-Yes this is a really rough first cut, I know.  It's mostly a proof of
-concept that this can actually work.  See the TODO file for a list of
-things left to be done.
+REQUIREMENTS:
+        Linux kernel >= 2.6.39
+                with devtmpfs
+                with cgroups (but it's OK to disable all controllers)
+                optional but strongly recommended: autofs4, ipv6
+        dbus >= 1.4.0
+        libcap
+        libblkid >= 2.20 (from util-linux) (optional)
+        libkmod >= 5 (optional)
+        PAM >= 1.1.2 (optional)
+        libcryptsetup (optional)
+        libaudit (optional)
+        libacl (optional)
+        libattr (optional)
+        libselinux (optional)
+        liblzma (optional)
+        tcpwrappers (optional)
+        libgcrypt (optional)
+        libqrencode (optional)
+        libmicrohttpd (optional)
+        libpython (optional)
+        make, gcc, and similar tools
 
-Any comment/questions/concerns please let me know.
+        During runtime you need the following additional dependencies:
 
-greg k-h
-greg@kroah.com
+        util-linux >= v2.19 (requires fsck -l, agetty -s)
+        sulogin (from util-linux >= 2.22 or sysvinit-tools, optional but recommended)
+        dracut (optional)
+
+        When building from git you need the following additional dependencies:
+
+        docbook-xsl
+        xsltproc
+        automake
+        autoconf
+        libtool
+        intltool
+        gperf
+        gtkdocize (optional)
+        python (optional)
+
+        When systemd-hostnamed is used it is strongly recommended to
+        install nss-myhostname to ensure that in a world of
+        dynamically changing hostnames the hostname stays resolvable
+        under all circumstances. In fact, systemd-hostnamed will warn
+        if nss-myhostname is not installed.
+
+        Note that D-Bus can link against libsystemd-login.so, which
+        results in a cyclic build dependency. To accommodate for this
+        please build D-Bus without systemd first, then build systemd,
+        then rebuild D-Bus with systemd support.
+
+WARNINGS:
+        systemd will warn you during boot if /etc/mtab is not a
+        symlink to /proc/mounts. Please ensure that /etc/mtab is a
+        proper symlink.
+
+        systemd will warn you during boot if /usr is on a different
+        file system than /. While in systemd itself very little will
+        break if /usr is on a separate partition many of its
+        dependencies very likely will break sooner or later in one
+        form or another. For example udev rules tend to refer to
+        binaries in /usr, binaries that link to libraries in /usr or
+        binaries that refer to data files in /usr. Since these
+        breakages are not always directly visible systemd will warn
+        about this, since this kind of file system setup is not really
+        supported anymore by the basic set of Linux OS components.
+
+        For more information on this issue consult
+        http://freedesktop.org/wiki/Software/systemd/separate-usr-is-broken
+
+        To run systemd under valgrind, compile with VALGRIND defined
+        (e.g. ./configure CPPFLAGS='... -DVALGRIND=1'). Otherwise,
+        false positives will be triggered by code which violates
+        some rules but is actually safe.
+
+ENGINEERING AND CONSULTING SERVICES:
+        ProFUSION <http://profusion.mobi> offers professional
+        engineering and consulting services for systemd for embedded
+        and other use. Please contact Gustavo Barbieri
+        <barbieri@profusion.mobi> for more information.
+
+        Disclaimer: This notice is not a recommendation or official
+        endorsement. However, ProFUSION's upstream work has been very
+        beneficial for the systemd project.