diff --git a/README.md b/README.md index 4e72dbe..277669e 100644 --- a/README.md +++ b/README.md @@ -1 +1,26 @@ # PorQua +## Development Setup + +1. Clone the repository: + git clone https://github.com/GeomScale/PorQua.git + cd PorQua + +2. (Optional) Create a virtual environment: + python -m venv venv + venv\Scripts\activate # On Windows + +3. Install required packages manually as needed. + +--- + +## Running Tests + +Tests are located inside the `test/` directory. + +To run tests: + + pytest test/ + +If pytest is not installed: + + pip install pytest