From f5763c04652e2f1d49adf2c1ad6ed09b8a2ce0d3 Mon Sep 17 00:00:00 2001 From: Joongi Kim Date: Tue, 11 Jun 2024 17:09:21 +0900 Subject: [PATCH] Update README --- README.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.rst b/README.rst index ef1b1647..9085fafa 100644 --- a/README.rst +++ b/README.rst @@ -44,6 +44,29 @@ dependency sets. pip install -U pip pip install -e '.[ci,dev]' # in zsh, you need to escape brackets + pre-commit install + +Running tests +~~~~~~~~~~~~~ + +.. code-block:: sh + + # Run all tests + make test + + # Run individual tests + python -m pytest tests/test_images.py + + +Building packages +~~~~~~~~~~~~~~~~~ + +NOTE: Usually you don't need to run this step by yourself. + +.. code-block:: sh + + pip install -U build + python -m build --sdist --wheel Documentation