diff --git a/README b/README.rst similarity index 66% rename from README rename to README.rst index d05d548e..406b4d58 100644 --- a/README +++ b/README.rst @@ -1,24 +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:: -* 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 + +* 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 +* A bunch of the scripts for building and such from the Rails 2.1 book by + Carlos Brando -== Authors == +Authors +------- * Scott Chacon * Emil Sit