]> rtime.felk.cvut.cz Git - coffee/buildroot.git/blobdiff - README
exim: do not link buildconfig with $(LIBS)
[coffee/buildroot.git] / README
diff --git a/README b/README
index 3729dfc139c600eb23d1edf2e5c243c5b3af3884..c6172524d789840fb6ca9eb34c0fd915112f13ca 100644 (file)
--- a/README
+++ b/README
@@ -1,19 +1,26 @@
+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:
 
-1) run 'make'
-2) select which packages you wish to compile
+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) Use your shiney new root filesystem.  Depending on which sortof
-    root filesystem you selecter, you may want to loop mount it,
-    chroot into it, loop mount it and then nfs mount that on your
-    target device, burn it to flash, or whatever is appropriate
-    for your target system.
+5) find the kernel, bootloader, root filesystem, etc. in output/images
 
 You do not need to be root to build or run buildroot.  Have fun!
 
- -Erik
+Buildroot comes with a basic configuration for a number of boards. Run
+'make list-defconfigs' to view the list of provided configurations.
 
-Please feed suggestions, bug reports, insults, and bribes back to:
-       Erik Andersen <andersen@codepoet.org>
+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