Skip to content

Commit

Permalink
in inner project README, install instruction are now more generic/pyp…
Browse files Browse the repository at this point in the history
…i agnostic
  • Loading branch information
telamonian committed Jun 21, 2024
1 parent 1ad2e66 commit c38211b
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions {{cookiecutter.project_name}}/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,36 @@
# {{cookiecutter.project_slug}}
# {{cookiecutter.project_name}}

## {{cookiecutter.project_short_description}}

## Install

To install the extension, execute:
After you download this extension, you can install it with:

```bash
pip install {{cookiecutter.project_slug}}
cd {{cookiecutter.project_name}}
pip install .
```

To install the latest version of the extension from github:

```bash
pip install {{cookiecutter.project_name}}@git+https://github.com/{{cookiecutter.__gh_slug}}
```

## Uninstall

To remove the extension, execute:

```bash
pip uninstall {{cookiecutter.project_slug}}
pip uninstall {{cookiecutter.project_name}}
```

## Develop

To install the dev dependencies and pre-commit (will run the ruff hook), do:

```bash
cd {{cookiecutter.project_name}}
pip install -e .[dev]
pre-commit install
```
Expand Down

0 comments on commit c38211b

Please sign in to comment.