diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..f761bad2375c7e789b847c298cda0445d9ca12b9 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Dynare reference manual + +Source for the Dynare's reference manual which is available at +<http://www.dynare.org/manual-unstable>. The documentation is obtained +using [Sphinx](http://www.sphinx-doc.org/) Pyhthon Documentation +Generator. To build the `html` version of the reference manual just type: + +```bash +~$ make html +``` + +on the command line. The reference manual will be available under +`src/build/html`, provided all the following (debian package) +requirements are met: + + - python3, + - python3-sphinx, + - python3-recommonmark, and + - libjs-mathjax