From f1a4ff1084a2d6150a053eed896d58e46471f2aa Mon Sep 17 00:00:00 2001 From: Houtan Bastani Date: Fri, 9 Aug 2019 13:58:44 -0400 Subject: [PATCH] update readme --- README.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 80aa529..28237ef 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,20 @@ # Dynare Reporting Originally designed to provide reporting functionality for -[Dynare](http://www.dynare.org), it has been moved to its own -repository in the hopes that it can be used without obliging the user -to download Dynare in its entirety. +[Dynare](https://www.dynare.org), it has been moved to its own repository in the +hopes that it can be used without obliging the user to download Dynare in its +entirety. # License -Dynare Reporting is covered by the GNU General Public Licence version 3 or later -(see [LICENSE.md](LICENSE.md) in the Dynare Reporting distribution for +Dynare Reporting is covered by the GNU General Public Licence version 3 or +later (see [LICENSE.md](LICENSE.md) in the Dynare Reporting distribution for specifics). # Obtain the code that Dynare Reporting depends on Dynare ```reporting``` depends on the Dynare -[```dates```](https://git.dynare.org/Dynare/dates) and -[```dseries```](https://git.dynare.org/Dynare/dseries) repositories and on +[```dseries```](https://git.dynare.org/Dynare/dseries) repository and on utility functions from the [```dynare```](https://git.dynare.org/Dynare/dynare) repository, located in ```dynare/matlab/utilities/general``` @@ -23,11 +22,11 @@ repository, located in ```dynare/matlab/utilities/general``` - Open Matlab/Octave - Change into the ```reporting``` directory -- Ensure that the [```dates```](https://git.dynare.org/Dynare/dates) - and [```dseries```](https://git.dynare.org/Dynare/dseries) - directories are in your path and initialized correctly (follow the - directions on the respective sites) -- Add ```<>/matlab/utilities/general``` to your path where ```<>``` refers to the base of your Dynare installation +- Ensure that the [```dseries```](https://git.dynare.org/Dynare/dseries) + directory is in your path and initialized correctly (follow the directions on + the repository site) +- Add ```<>/matlab/utilities/general``` to your path where + ```<>``` refers to the base of your Dynare installation - Run ```initialize_reporting_toolbox``` - Use the reporting code as outlined in the Dynare documentation -- GitLab