Browse Source

updated README.md to include very rough instructions on how to contribute

pull/1/head
Brett Langdon 14 years ago
parent
commit
9bddc06ce9
1 changed files with 9 additions and 13 deletions
  1. +9
    -13
      README.md

+ 9
- 13
README.md View File

@ -13,20 +13,16 @@ Enjoy.
I will always try to keep the lastest pdf version of the book provided in the repository, but if I forgot then you can build the pdf from source.
## Build PDF
To build from source you must have latex and python installed.
To build you just run the provided "build" script which will compile the main .tex source
from the chapter subdirectories. Then it compiles the .pdf version from that
## Contributing
### Instructions:
Please! Fork this project, write a chapter, a section or even just fix my terrible grammar and make a pull request. I will ensure to give credit where credit due!
git clone git://github.com/brettlangdon/programming-in-general.git
cd "programming-in-general"
./build
Output will be:
A few things to keep in mind when contributing actual writing, I have been keeping a few standards such as keeping a single empty space between paragraphs, new sections and code blocks.
"Programming In General.tex"
and
"Programming In General.pdf"
There are three commands I have added to latex for this book, `\pigVar, \pigVal and \pigOut`, they are fairly easy to figure out. `\pigVar` is for when variables, functions, class properties, etc are stated in text, `\pigVal` is when values are stated in code and `\pigOut` is used when writing the output of code.
These commands are used as `\pigVar{name} is equal to \pigVal{22}`.
The main directory, chapter and section structure might be a little weird, I am new to latex and wanted a way to separate out chapters and sections and well of course I wrote a script to do it for me. Each chapter has its own directory, with its chapter number and name, the chapter introduction text is provided in a file with the same EXACT name as the chapter without the number and .tex on the end and all sections are numbers as 1.1, 1.2, etc and then their section name. They are 1.# because thats the way I did it and live with it.
Please take a look at some of the chapters and sections already written for a better understanding.

Loading…
Cancel
Save