Skip to content

Commit 2d7eeec

Browse files
chore: update README.md
1 parent 9ab2163 commit 2d7eeec

1 file changed

Lines changed: 3 additions & 7 deletions

File tree

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,12 @@ An algorithm to form mentorship groups between student mentees and mentors.
55
## Algorithmic Overview
66
Provided the availability of mentees and mentors, fix a time for a mentor to have a mentorship group based on their availability (phase one), and assign mentees to that mentorship group if it is also in their availability. We let availability denote a collection of one hour timeslots on a specific day.
77

8-
## Abstract Datatypes
9-
- Person
10-
- Group
11-
128
## Development Setup
13-
The project uses `ruff`, `mypy`, and `pre-commit` for linting, formatting, type-checking, and code consistency checks. You can install all of these tools using `uv tool install` and run them on the project where the respective tool configurations are stored in the `pyproject.toml`.
9+
The project uses `ruff`, `ty`, and `pre-commit` for linting, formatting, type-checking, and code consistency checks. You can install all of these tools using `uv tool install` and run them on the project where the respective tool configurations are stored in the `pyproject.toml`.
1410

1511
Setup the virtual environment:
1612
```
17-
uv venv
13+
uv sync
1814
```
1915

2016
Setup testing:
@@ -32,4 +28,4 @@ pre-commit run -a
3228
## Program Usage
3329
```
3430
uv run src/mentor_match
35-
```
31+
```

0 commit comments

Comments
 (0)