diff --git a/README.md b/README.md index ffd1948d..8eabcc8f 100644 --- a/README.md +++ b/README.md @@ -59,13 +59,13 @@ They have their own README file as well. The documentation can be built offline from a git clone or source distribution. Install documentation builder dependencies with `pip install '.[doc]'`. -Run the make command `make html` which will output the documentation, -including the generated API reference, into a folder called `html`. +Run `make html` from the terminal to generate PyDRex's documentation +(available in the `html` directory), including the API reference. The homepage will be `html/index.html`. ## Contributing -For a Linux development environment, clone the [source code](https://github.com/seismic-anisotropy/PyDRex) +For a Linux or MacOS development environment, clone the [source code](https://github.com/seismic-anisotropy/PyDRex) and execute the Bash script `tools/venv_install.sh`. This will set up a local Python virtual environment with an [editable install](https://setuptools.pypa.io/en/latest/userguide/development_mode.html) of PyDRex that can be activated/deactivated by following the displayed prompts. diff --git a/tests/README.md b/tests/README.md index 4f22c54b..49a40b35 100644 --- a/tests/README.md +++ b/tests/README.md @@ -1,6 +1,6 @@ # PyDRex tests -Running the base test suite requires [pytest](https://docs.pytest.org), and up to ~16GB RAM. +Running the base test suite requires [pytest](https://docs.pytest.org) and up to ~16GB RAM. By default, `make test` will attempt to write persistent logs and output to `./out/`. Alternatively, run `pytest` from the root of the source tree.