From 4e4b3679766b2ca9d134de90f7bf7956289ecb60 Mon Sep 17 00:00:00 2001 From: Jean Jordaan Date: Thu, 13 Oct 2011 16:57:32 +0700 Subject: [PATCH 1/2] Change README to markdown --- README => README.markdown | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) rename README => README.markdown (78%) diff --git a/README b/README.markdown similarity index 78% rename from README rename to README.markdown index d05d548e..ad1e61d7 100644 --- a/README +++ b/README.markdown @@ -1,24 +1,33 @@ -== The Community Git Book == +## The Community Git Book ## This is an attempt to make a comprehensive, easy to follow Git learning resource to be hosted on the main Git website. -== Contributing == +## Contributing ## + +* Clone this source, add to it and send me (schacon@gmail.com) a patch or + pull request -* Clone this source, add to it and send me (schacon@gmail.com) a patch or pull request * Install required gems: + $ gem install rake ultraviolet discount rdiscount builder + * For PDF output install prince (http://www.princexml.com/download/) + * Generate book through + $ rake html + or + $ rake pdf -== References == +## References ## -* A bunch of the scripts for building and such from the Rails 2.1 book by Carlos Brando +* A bunch of the scripts for building and such from the Rails 2.1 book by + Carlos Brando -== Authors == +## Authors ## * Scott Chacon * Emil Sit From 690dbce6c40f74acade282a318f686b6999d880f Mon Sep 17 00:00:00 2001 From: Jean Jordaan Date: Thu, 13 Oct 2011 16:59:58 +0700 Subject: [PATCH 2/2] Switch to RST. --- README.markdown => README.rst | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) rename README.markdown => README.rst (74%) diff --git a/README.markdown b/README.rst similarity index 74% rename from README.markdown rename to README.rst index ad1e61d7..406b4d58 100644 --- a/README.markdown +++ b/README.rst @@ -1,33 +1,37 @@ -## The Community Git Book ## +The Community Git Book +---------------------- This is an attempt to make a comprehensive, easy to follow Git learning resource to be hosted on the main Git website. -## Contributing ## +Contributing +------------ * Clone this source, add to it and send me (schacon@gmail.com) a patch or pull request -* Install required gems: +* Install required gems:: $ gem install rake ultraviolet discount rdiscount builder * For PDF output install prince (http://www.princexml.com/download/) -* Generate book through +* Generate book through:: $ rake html - or + or:: $ rake pdf -## References ## +References +---------- * A bunch of the scripts for building and such from the Rails 2.1 book by Carlos Brando -## Authors ## +Authors +------- * Scott Chacon * Emil Sit