Skip to content

Commit

Permalink
Slight improvements of the testing section
Browse files Browse the repository at this point in the history
  • Loading branch information
kelson42 committed Aug 3, 2021
1 parent 45a25b7 commit d5baac5
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,19 +113,23 @@ xapian by testing the define `LIBZIM_WITH_XAPIAN`.
Testing
-------

ZIM files needed by unit-tests are not inculded in this
repository. You must tell Meson where the test data is located.

By default, Meson will use an internal directory in your build directory.
But you can specify another directory with option `test_data_dir`:
ZIM files needed by unit-tests are not included in this repository. By
default, Meson will use an internal directory in your build directory,
but you can specify another directory with option `test_data_dir`:
```bash
meson . build -Dtest_data_dir=<A_DIR_WITH_TEST_DATA>
```

Whatever you specify a directory or not, you need a extra step to download the data. At choice:
* Get the data from the repository [openzim/zim-testing-suite](https://github.com/openzim/zim-testing-suite) and put it yourself in the directory.
* Use the script [download_test_data.py](scripts/download_test_data.py) which will download and extract the data for you.
* As `ninja` to do it for you with `ninja download_test_data` once the project is configured.
Whatever you specify a directory or not, you need a extra step to
download the data. At choice:
* Get the data from the repository
[openzim/zim-testing-suite](https://github.com/openzim/zim-testing-suite)
and put it yourself in the directory.
* Use the script
[download_test_data.py](scripts/download_test_data.py) which will
download and extract the data for you.
* As `ninja` to do it for you with `ninja download_test_data` once the
project is configured.

The simple workflow is:
```bash
Expand Down

0 comments on commit d5baac5

Please sign in to comment.