Add building section to readme
Project: http://git-wip-us.apache.org/repos/asf/incubator-wave-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-wave-docs/commit/b84caa1b Tree: http://git-wip-us.apache.org/repos/asf/incubator-wave-docs/tree/b84caa1b Diff: http://git-wip-us.apache.org/repos/asf/incubator-wave-docs/diff/b84caa1b Branch: refs/heads/master Commit: b84caa1bca3b87a189c5ea8478738902f1271528 Parents: 88861bf Author: Ali Lown <a...@lown.me.uk> Authored: Sat May 16 00:16:43 2015 +0100 Committer: Ali Lown <a...@lown.me.uk> Committed: Sat May 16 00:16:43 2015 +0100 ---------------------------------------------------------------------- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-wave-docs/blob/b84caa1b/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 7fb8274..ddfac17 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,17 @@ running, managing and contributing to Apache Wave. In the meantime, please continue to use the existing documentation that can be found on our [website](http://incubator.apache.org/wave), in the [wiki](https://cwiki.apache.org/confluence/display/WAVE/Home), and at [Wave Protocol (old website)](http://www.waveprotocol.org). + +Building the Documentation +-------------------------- + +You will need Python and Sphinx installed for HTML documentation. +If you would also like the PDF formats, you will need a LaTeX distribution installed as well. + +On a Debian-based distribution, you can probably just run: +``` +apt-get install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended +``` + +To build the actual documentation, you should run `make doc-html` or `make doc-pdf`, depending on which type you want. +To see all commands, please run `make help`.
