Merge pull request #1383 from JohannesPfeifer/readme

readme.md: Fix typos and add info on make clean
time-shift
Stéphane Adjemian 2017-01-27 15:09:48 +01:00 committed by GitHub
commit 5285f581e8
1 changed files with 10 additions and 4 deletions

View File

@ -130,7 +130,7 @@ If you want to give a try to the parallelized versions of some mex files (`A_tim
``` ```
If the configuration goes well, the script will tell you which components are correctly configured and will be built. If the configuration goes well, the script will tell you which components are correctly configured and will be built.
### Bulding ### Building
Binaries and Info documentation are built with: Binaries and Info documentation are built with:
``` ```
@ -162,7 +162,7 @@ make check-matlab
``` ```
or only with Octave: or only with Octave:
``` ```
make check-matlab make check-octave
``` ```
A summary of the results is available in `tests/run_test_matlab_output.txt` or `tests/run_test_octave_output.txt`. Often, it does not make sense A summary of the results is available in `tests/run_test_matlab_output.txt` or `tests/run_test_octave_output.txt`. Often, it does not make sense
to run the complete testsuite. For instance, if you modify codes only related to the perfect foresight model solver, you can decide to run only a to run the complete testsuite. For instance, if you modify codes only related to the perfect foresight model solver, you can decide to run only a
@ -178,7 +178,7 @@ or with Octave:
``` ```
make o/deterministic_simulations make o/deterministic_simulations
``` ```
Finally if you want to run a single integration test with Matlab: Finally if you want to run a single integration test, e.g. `deterministic_simulations/lbj/rbc.mod` with Matlab:
``` ```
make deterministic_simulations/lbj/rbc.m.trs make deterministic_simulations/lbj/rbc.m.trs
``` ```
@ -194,12 +194,18 @@ or
``` ```
make deterministic_simulations/lbj/rbc.o.drs make deterministic_simulations/lbj/rbc.o.drs
``` ```
Note that only tests will be executed where the `m.trs/o.trs` does not yet exist. You can run
```
make clean
```
in the `tests` folder to delete files that were created by the run of the testsuite. You can also manually delete the desired `m.trs/o.trs` file(s).
## Debian or Ubuntu ## Debian or Ubuntu
All the prerequisites are packaged. All the prerequisites are packaged.
The easiest way to install the pre-requisites in Debian is to use Debian's dynare package and do: The easiest way to install the pre-requisites in Debian is to use Debian's dynare package and do
(requires that you have added the `deb-src` repositories to your `sources.list`):
``` ```
apt-get build-dep dynare apt-get build-dep dynare
``` ```