]> rtime.felk.cvut.cz Git - coffee/buildroot.git/blobdiff - README
configs/mx53loco: Adjust comment to reflect the real kernel version
[coffee/buildroot.git] / README
diff --git a/README b/README
index aef538959a95436b491530a499b0b29bd346cbbd..c6172524d789840fb6ca9eb34c0fd915112f13ca 100644 (file)
--- a/README
+++ b/README
@@ -1,28 +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.
+Buildroot is a simple, efficient and easy-to-use tool to generate embedded
+Linux systems through cross-compilation.
 
-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.
+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
 
-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:
+To build and use the buildroot stuff, do the following:
 
-    cvs -d:pserver:anonymous@busybox.net:/var/cvs login
+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
 
-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'.
+You do not need to be root to build or run buildroot.  Have fun!
 
-Have fun!
+Buildroot comes with a basic configuration for a number of boards. Run
+'make list-defconfigs' to view the list of provided configurations.
 
- -Erik
+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.
 
-Please feed suggestions, bug reports, insults, and bribes back to:
-       Erik Andersen <andersen@codepoet.org>
+If you would like to contribute patches, please read
+https://buildroot.org/manual.html#submitting-patches