Skip to content

Improve README with development setup and testing instructions #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
panduru-aadhithya wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve README with development setup and testing instructions #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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