From ff781288f336c658911fcdadbffc107e79a8515d Mon Sep 17 00:00:00 2001 From: "Yann E. MORIN\"" Date: Fri, 7 Aug 2009 18:30:45 +0200 Subject: Add sections to the README diff --git a/README b/README index ac7ef78..b90d07e 100644 --- a/README +++ b/README @@ -1,5 +1,19 @@ This is the README for crosstool-NG +TABLE OF CONTENT / +________________/ + + - GETTING STARTED + - PARTICIPATING + - Sending a bug report + - Sending patches + - CREDITS + - KNOWN ISSUES + + +GETTING STARTED / +_______________/ + To get you started, just enter: ./configure --help @@ -8,22 +22,37 @@ You can find a (terse and WIP) documentation in docs/overview.txt. You can also point your browser to http://ymorin.is-a-geek.org/projects/crosstool -If you want to enhance crosstool-NG, there's a to-do list in the TODO file. +PARTICIPATING / +_____________/ + +Sending a bug report +-------------------- -If you need to send a bug report or a patch, please send a mail with subject -prefixed with "[CT_NG]" to the following destinations: - TO: yann.morin.1998 (at) anciens.enib.fr - CC: crossgcc (at) sourceware.org +If you need to send a bug report, please send a mail with subject + prefixed with "[CT_NG]" with to following destinations: + TO: yann.morin.1998 (at) anciens.enib.fr + CC: crossgcc (at) sourceware.org + +Sending patches +--------------- + +If you want to enhance crosstool-NG, there's a to-do list in the TODO file. Patches should come with the appropriate SoB line. A SoB line is typically -something like: - Signed-off-by: John DOE + something like: + Signed-off-by: John DOE The SoB line is clearly described in Documentation/SubmittingPatches , section 12, of your favourite Linux kernel source tree. +CREDITS / +_______/ + The people that helped are listed in docs/CREDITS. Many thanks to them! :-) +KNOWN ISSUES / +____________/ + The list of known issues is listed in docs/known-issues.txt. Aloha! -- cgit v0.10.2-6-g49f6