summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
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