Added lxc.monitor.unshare

[mirror_lxc.git] / README

diff --git a/README b/README
index b81e7a9231212863a11a7a1140c90be6e3bc55b6..3e2a963697557ac8c072977096a71652d1076669 100644 (file)
--- a/README
+++ b/README
@@ -8,8 +8,8 @@ What is lxc:
   process containers and resource isolation through the namespaces.
 
   The  linux  containers, lxc, aims to use these new functionalities to pro-
-  vide an userspace container object which provides full  resource  isolation
-  and resource control for an applications or a system.
+  vide a userspace container object which provides full  resource  isolation
+  and resource control for an application or a system.
 
   The first objective of this project is to make the life easier for the ker-
   nel developers involved in the containers project and  especially  to  con-
@@ -24,22 +24,38 @@ Using lxc:
 Downloading the current source code:
 
   Source for the latest released version can always be downloaded from
-  http://lxc.sourceforge.net/download/lxc
+  http://linuxcontainers.org/downloads/
 
   You can browse the up to the minute source code and change history online.
-  http://lxc.git.sourceforge.net
+  http://github.com/lxc/lxc
 
   For detailed build instruction refer to INSTALL and man lxc man page
   but a short command line should work:
-  ./autogen.sh && ./configure && make && sudo make install && sudo lxc-setcap
+  ./autogen.sh && ./configure && make && sudo make install
   preceded by ./autogen.sh if configure do not exist yet.
 
+Troubleshooting:
+
+  If you get an error message at the autogen.sh or configure stage, make
+  sure you have, autoconf, automake, pkg-config, make and gcc installed on
+  your machine.
+
+  The configure script will usually give you hints as to what you are missing,
+  looking for those in your package manager will usually give you the package
+  that you need to install.
+
+  Also pay a close attention to the feature summary showed at the end of
+  the configure run, features are automatically enabled/disabled based on
+  whether the needed development packages are installed on your machine.
+  If you want a feature but don't know what to install, force it with
+  --enable-<feature> and look at the error message from configure.
+
 Getting help:
 
   when you find you need help, you can check out one of the two
   lxc mailing list archives and register if interested:
-  https://lists.sourceforge.net/lists/listinfo/lxc-devel
-  https://lists.sourceforge.net/lists/listinfo/lxc-users
+  http://lists.linuxcontainers.org/listinfo/lxc-devel
+  http://lists.linuxcontainers.org/listinfo/lxc-users
 
 Portability:
 
@@ -48,7 +64,9 @@ Portability:
 
   lxc is developed and tested on Linux since kernel mainline version 2.6.27
   (without network) and 2.6.29 with network isolation.
-  is compiled with gcc, and supports i686, x86_64, ppc, ppc64, S390 archi.
+  It's compiled with gcc, and should work on most architectures as long as the
+  required kernel features are available. This includes (but isn't limited to):
+  i686, x86_64, ppc, ppc64, S390, armel and armhf.
 
 AUTHOR
        Daniel Lezcano <daniel.lezcano@free.fr>
@@ -69,10 +87,10 @@ cat > seccomp.full << EOF
 whitelist
 EOF
 for i in `seq 0 300`; do
-       echo $i >> secomp.full
+    echo $i >> seccomp.full
 done
 for i in `seq 1024 1079`; do
-       echo $i >> seccomp.full
+    echo $i >> seccomp.full
 done
 
  -- Serge Hallyn <serge.hallyn@ubuntu.com>  Fri, 27 Jul 2012 15:47:02 +0600