]> rtime.felk.cvut.cz Git - coffee/buildroot.git/blobdiff - README
wget: security bump to version 1.19.5
[coffee/buildroot.git] / README
diff --git a/README b/README
index 533db7340e15cb9356642ab091530d3023084908..c6172524d789840fb6ca9eb34c0fd915112f13ca 100644 (file)
--- a/README
+++ b/README
@@ -1,45 +1,26 @@
-To build and use the buildroot stuff, do the following:
-
-1) run 'make'
-2) wait while it compiles 
-3) run './UMlinux' to test out your root filesystem using User Mode Linux.
-
-You do not need to be root to build or run this system.  Each Virtual Terminal
-will be opened in its own window.  You must be running X and have xterm
-installed for this to work -- otherwise you see a few errors on bootup as it
-tries to launch xterms.   It will still work on a console, but you will not
-have access to the other Virtual Terminals.
-
-Also, you the uClibc and busybox source trees that
-are downloaded are fully set up for anonymous CVS access.  You may need to set
-up your system for anonymous CVS access by running the following command:
-
-    cvs -d:pserver:anonymous@busybox.net:/var/cvs login
-
-Then just hit Enter when it prompts you for a password.  You only need to do
-this once.  Then, whenever you want to update your system, just go into the
-busybox or uClibc directory and run 'cvs update'.
-
-Have fun!
-
- -Erik
-
-Please feed suggestions, bug reports, insults, and bribes back to:
-       Erik Andersen <andersen@codepoet.org>
+Buildroot is a simple, efficient and easy-to-use tool to generate embedded
+Linux systems through cross-compilation.
 
+The documentation can be found in docs/manual. You can generate a text
+document with 'make manual-text' and read output/docs/manual/manual.text.
+Online documentation can be found at http://buildroot.org/docs.html
 
+To build and use the buildroot stuff, do the following:
 
-NOTE:
+1) run 'make menuconfig'
+2) select the target architecture and the packages you wish to compile
+3) run 'make'
+4) wait while it compiles
+5) find the kernel, bootloader, root filesystem, etc. in output/images
 
-    For './configure' to behave itself with certain applications, you may need
-    to create a symlink under "/lib" on your system that points to the uClibc
-    shared library loader in the staging directory.  For example, on my system
+You do not need to be root to build or run buildroot.  Have fun!
 
-        $ cd /lib
-       $ sudo ln -s /home/andersen/buildroot/build/staging_dir/lib/ld-uClibc.so.0 ld-uClibc.so.0
+Buildroot comes with a basic configuration for a number of boards. Run
+'make list-defconfigs' to view the list of provided configurations.
 
-    If you don't use sudo, run 'su -' to become root when making the link.  If
-    you aren't root it won't work.  The reason for this symlink, is it allows
-    './configure' to actually execute the test applications it compiles against
-    uClibc during the configuration process....
+Please feed suggestions, bug reports, insults, and bribes back to the
+buildroot mailing list: buildroot@buildroot.org
+You can also find us on #buildroot on Freenode IRC.
 
+If you would like to contribute patches, please read
+https://buildroot.org/manual.html#submitting-patches