Merge pull request #1 from addyosmani/gh-pages

merge upstream

Author: gschema

.gitignore

@@ -1 +1,2 @@
 .DS_Store
+*.log

Makefile

@@ -1,13 +1,16 @@
 include_dir=build
-source=index.md
+source=chapters/*.md
 title='Developing Backbone.js Applications'
 filename='backbone-fundamentals'
 
 
 all: html epub rtf pdf mobi
 
-html:
-	pandoc -s $(source) -t html5 -o index.html -c style.css \
+markdown:
+	awk 'FNR==1{print ""}{print}' $(source) > $(filename).md
+
+html: markdown
+	pandoc -s $(filename).md -t html5 -o index.html -c style.css \
 		--include-in-header $(include_dir)/head.html \
 		--include-before-body $(include_dir)/author.html \
 		--include-before-body $(include_dir)/share.html \
@@ -17,8 +20,8 @@ html:
 		--smart \
 		--toc
 
-epub:
-	pandoc -s $(source) --normalize --smart -t epub -o $(filename).epub \
+epub: markdown
+	pandoc -s $(filename).md --normalize --smart -t epub -o $(filename).epub \
 		--epub-metadata $(include_dir)/metadata.xml \
 		--epub-stylesheet epub.css \
 		--epub-cover-image img/cover.jpg \
@@ -27,22 +30,23 @@ epub:
 		--smart \
 		--toc
 
-rtf:
-	pandoc -s $(source) -o $(filename).rtf \
+rtf: markdown
+	pandoc -s $(filename).md -o $(filename).rtf \
 		--title-prefix $(title) \
 		--normalize \
 		--smart
 
-pdf:
+pdf: markdown
 	# You need `pdflatex`
 	# OS X: http://www.tug.org/mactex/
 	# Then find its path: find /usr/ -name "pdflatex"
 	# Then symlink it: ln -s /path/to/pdflatex /usr/local/bin
-	pandoc -s $(source) -o $(filename).pdf \
+	pandoc -s $(filename).md -o $(filename).pdf \
 		--title-prefix $(title) \
 		--normalize \
 		--smart \
-		--toc
+		--toc \
+		--latex-engine=`which xelatex` 
 
 mobi: epub
 	# Download: http://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000765211

README.md

@@ -2,16 +2,36 @@
 
 ## About
 
-This is the home of [Developing Backbone.js Applications](http://shop.oreilly.com/product/0636920025344.do), an (in-progress) book about the 
-Backbone.js library for structuring JavaScript applications. It is released under a 
-Creative Commons Attribution-Noncommercial- No Derivative Works 3.0 United States License and is currently available for early purchase via O'Reilly if you would like to support the project.
+This is the home of [Developing Backbone.js Applications](http://shop.oreilly.com/product/0636920025344.do), an open-source book about the Backbone.js library for structuring JavaScript applications. It is released under a 
+Creative Commons Attribution-Noncommercial-No Derivative Works 3.0 United States License and is currently available for early purchase via O'Reilly if you would like to support the project.
 
-We appreciate any and all efforts to help improve the book. If you would like to submit pull requests, please feel free to apply them against `index.md`. These can be previewed by running the build script via `make`, which will also generate updated versions of the other formats we support.
+## Contributing
+
+We appreciate any and all efforts to help improve the book. Please note that the repository is structured as follows:
+
+* chapters - contains the source Markdown for each chapter. This is compiled into the HTML, ePub, Mobi and other formats found in the root of the project.
+* build - contains templates and metadata for compiling the book
+* img - contains image assets for the project
+* practicals - contains the source code for practicals
+
+If you would like to submit pull requests, please feel free to apply them against the relevant markdown file in `chapter`. These can be previewed by running the build script via `make`, which will also generate updated versions of the other formats we support. Please ensure that you are only submitting the modified chapter file for your changes and not the compiled HTML/other format binaries. 
 
 ## Reviews
 
-If you are interested in leaving a review to let others know what you thoughts of the book this can be done through [O'Reilly](http://shop.oreilly.com/product/0636920025344/ReviewSubmit.do?sortby=publicationDate?pageId=0636920025344.IP).
+If you are interested in leaving a review to share your opinion on the book with others (it's always appreciated!), you can do so through [O'Reilly](http://shop.oreilly.com/product/0636920025344/ReviewSubmit.do?sortby=publicationDate?pageId=0636920025344.IP).
 
 ## Building
 
-You can build the book using `make` or `make -f Makefile`. This will output the HTML, ePub, PDF and RTF versions of the book. 
+You can build the book using `make` or `make -f Makefile`. This will output the HTML, ePub, Mobi, PDF and RTF versions of the book. 
+
+Note: At this time, generating all of the above formats should be straight-forward with the exception of the PDF. We have an open [pull-request](https://github.com/addyosmani/backbone-fundamentals/pull/369) for `xelatex` which is being considered and better guides for working around cross-platform PDF issues will be supplied as time allows.
+
+### Dependencies
+
+* Make
+* [Pandoc](https://github.com/jgm/pandoc)
+* pdflatex (and recommended latex fonts)
+
+#### Linux Debian based distros:
+
+<code>apt-get install pandoc texlive-latex-base texlive-fonts-recommended cm-super etoolbox</code>