summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJean-Marie Lemetayer <jeanmarie.lemetayer@gmail.com>2015-09-16 09:03:55 (GMT)
committerJean-Marie Lemetayer <jeanmarie.lemetayer@gmail.com>2015-09-16 09:07:49 (GMT)
commit419aadedd47d0a612a25c9ae66ef0ba754cd431d (patch)
treea88b7df0bf9adadc139facfa9c7841b03f9e18e2 /README.md
parentc2f3ec1defb49510afe42f934bd84f380e32f7a6 (diff)
Replace README to README.md and add travis-ci status
Signed-off-by: Jasmin Jessich <jasmin@anw.at> Signed-off-by: Jean-Marie Lemetayer <jeanmarie.lemetayer@gmail.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2858138
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# Crosstool-NG [![Build Status][travis-status]][travis]
+
+Crosstool-NG follows the `autoconf` dance. So, to get you
+kick-started, just run:
+
+ ./configure --help
+
+If you are using a development snapshot, you'll have to
+create the configure script, first. Just run:
+
+ ./bootstrap
+
+You will find the documentation in the directory `docs`.
+Here is a quick overview of what you'll find there:
+
+<ol start="0">
+ <li>Table of content</li>
+ <li>Introduction</li>
+ <li>Installing crosstool-NG</li>
+ <li>Configuring a toolchain</li>
+ <li>Building the toolchain</li>
+ <li>Using the toolchain</li>
+ <li>Toolchain types</li>
+ <li>Contributing</li>
+ <li>Internals</li>
+</ol>
+<ol type="A">
+ <li>Credits</li>
+ <li>Known issues</li>
+ <li>Misc. tutorials</li>
+</ol>
+
+You can also point your browser at: http://crosstool-ng.org
+
+Aloha!
+
+[travis-status]: https://travis-ci.org/crosstool-ng/crosstool-ng.svg
+[travis]: https://travis-ci.org/crosstool-ng/crosstool-ng