From 6f28c71029e0cbfb4f34b8349d2f349342f7ab14 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Adjemian=20=28Charybdis=29?= Date: Tue, 19 Feb 2019 10:41:45 +0100 Subject: [PATCH] Added README. --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..f761bad23 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Dynare reference manual + +Source for the Dynare's reference manual which is available at +. 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