Permalink
Browse files

Add pdf instructions

  • Loading branch information...
1 parent 0e9abbe commit 3e0d2da7676c9d3b7d976212db58d6ec23a66d3a Erica Pisani committed Nov 29, 2013
Showing with 12 additions and 1 deletion.
  1. +12 −1 README.mdown
View
13 README.mdown
@@ -43,10 +43,21 @@ After installing the required packages, you can build the documentation using `M
# Populate the search index
make populate-index
-This will generate all the documentation in an html form. Other output such as 'pdf' and 'htmlhelp' are not fully complete at this time.
+This will generate all the documentation in an html form. Other output such as 'htmlhelp' are not fully complete at this time.
After making changes to the documentation, you can build the html version of the docs by using `make html` again. This will build only the html files that have had changes made to them.
+Building the PDF
+----------------
+
+Building the PDF is a non-trivial task.
+
+1. Install Latex - This varies by distribution/OS so refer to your package manager. You should install the full LaTeX package. The basic one requires many additional packages to be installed with `tlmgr`
+2. Run `make latex-en`.
+3. Run `make pdf-en`.
+
+At this point the completed PDF should be in build/latex/en/CakePHPCookbook.pdf.
+
Contributing
------------

0 comments on commit 3e0d2da

Please sign in to comment.