diff --git a/tests/README.md b/tests/README.md index 9b65d433..01b6b0af 100644 --- a/tests/README.md +++ b/tests/README.md @@ -9,6 +9,13 @@ To run the tests, do the following from the main source folder: Running the tests this way allows the library to be tested without installing it. +## Skipped Tests ## +A few tests will look for certain environment variables to determine if they should run. + +Some of the export tests rely on photos in my local library and will look for `OSXPHOTOS_TEST_EXPORT=1` to determine if they should run. + +One test for locale does not run on GitHub's automated workflow and will look for `OSXPHOTOS_TEST_LOCALE=1` to determine if it should be run. If you want to run this test, set the environment variable. + ## Attribution ## These tests utilize a test Photos library. The test library is populated with photos from [flickr](https://www.flickr.com). All images used are licensed under Creative Commons 2.0 Attribution [license](https://creativecommons.org/licenses/by/2.0/).