Skip to content

Commit

Permalink
Add extended installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
lpsinger committed Jul 16, 2024
1 parent 515387e commit 59d3e53
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,21 @@ the same format as notice packets, except that the notice type is
Because this protocol does not have any authentication, it must be tunneled
using a tool like ssh or stunnel.

## To install
## To hack

$ pip install .
This package uses [Poetry](https://python-poetry.org) for packaging and Python virtual environment management. To get started:

## To hack
1. [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) and [clone](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo#cloning-your-forked-repository) this repository.

2. Install Poetry by following [their installation instructions](https://python-poetry.org/docs/#installation).

3. Install this package and its dependencies by running the following command inside your clone of this repository:

poetry install --all-extras

This project uses [Poetry]. To hack on it, first [install Poetry]. Then, run
the following commands to set up and enter the development virtual environment:
4. Run the following command to launch a shell that is preconfigured with the project's virtual environment:

$ poetry install
$ poetry shell
poetry shell

## To monitor

Expand Down

0 comments on commit 59d3e53

Please sign in to comment.