Skip to content

Commit

Permalink
docs: simplify readme a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
amitkparekh committed Dec 2, 2023
1 parent b9db7be commit 3d620d0
Showing 1 changed file with 1 addition and 8 deletions.
9 changes: 1 addition & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
To use this package in your project, you can install it by running

```bash
poetry add git+https://github.com/emma-simbot/datasets#main
poetry add git+https://github.com/emma-simbot/datasets.git
```

You can then just import from `emma_datasets` or run commands using the CLI with
Expand All @@ -45,13 +45,6 @@ You can then just import from `emma_datasets` or run commands using the CLI with
python -m emma_datasets
```

<details>
<summary> Why does this install the main branch and not the most-stable version?</summary>
<br />
If you are using Poetry, this command will currently install from the main branch and not the latest released version. The `#main` suffix can be removed once [this issue in Poetry](https://github.com/python-poetry/poetry/issues/5152) is fixed.

</details>

## Writing code and running things

When running commands for `emma_datasets`, you can append `--help` to get more information on the commands and any arguments available to you.
Expand Down

0 comments on commit 3d620d0

Please sign in to comment.