diff options
Diffstat (limited to 'Docs/README.md')
| -rw-r--r-- | Docs/README.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/Docs/README.md b/Docs/README.md new file mode 100644 index 000000000..fa3705b63 --- /dev/null +++ b/Docs/README.md @@ -0,0 +1,25 @@ +# Overview + +This explains how to generate the documentation for Warpx. + +## Installing the requirements + +Install the Python requirements for compiling the documentation: +``` +pip install sphinx breathe +``` +and install Doxygen. Doxygen can be installed under Linux Debian by using +``` +apt-get install doxygen +``` +and under MacOSX by using Homebrew +``` +brew install doxygen +``` + +## Compiling the documentation + +`cd` into this directory and type +``` +make html +``` |