Skip to content
Prev Previous commit
Next Next commit
Added README
  • Loading branch information
Mindstan committed Sep 13, 2022
commit 951de69b12b6b642f4cd547f21d2566c98511a0f
56 changes: 56 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,57 @@
# Fork of YOLOv5

## About the package

\# TODO

## Package management

### Makefile

Poetry `~1.2` is required to run the Makefile.

Install the environment:

```bash
make env
```

Build the source and wheel distribution:

```bash
make dist
```

Build and release the package to the private PyPI (requires to setup Poetry auth), and tag this commit:
```bash
make release
```

Remove all temporary files (cached Python code)
```bash
make clean
```

### Poetry

This package is using Poetry. Here are some usefull commands.

```bash
# Install current package environment
poetry install

# Install current package environment with dev dependencies
poetry install --with dev

# Run a command inside the virtualenv
poetry run my_command

# Enter the virtualenv (exit with exit command or <CTRL+D>)
poetry shell

# Update dependances
poetry lock

# Refresh lock file without looking for updated packages
poetry lock --no-update
```