Skip to content

Commit

Permalink
docs(readme): add local installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Elijas committed Nov 14, 2023
1 parent bd25b6a commit a51bc83
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,3 +110,15 @@ for line in html.splitlines():
<span style="color:#000000;font-family:'Helvetica',sans-serif;fon...
<top-level-section-separator id="part2item6" title="Exhibits" comment=...
<span style="color:#000000;font-family:'Helvetica',sans-serif;fon...

## Contributing

Follow these steps to install the project locally for development:

1. Install the project with the command `pip install -e ".[dev]"`.

> **Note**
We highly recommend using virtual environments for Python development. If you're using virtual environments, follow these steps instead:
> - Create a virtual environment `python3 -m venv .venv`
> - Activate the virtual environment `source .venv/bin/activate`
> - Install the project with the command `pip install -e ".[dev]"`

0 comments on commit a51bc83

Please sign in to comment.