Skip to content

Commit

Permalink
chore: update README with better pyenv guide (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
guangie88 authored Oct 7, 2024
1 parent 6c7f451 commit fecb922
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,13 @@ repositories.

## Developer Set-up

This set-up assumes you have a fresh Python environment, e.g. `pyenv virtualenv cc-changelog-gen &&
pyenv activate cc-changelog-gen` with Python 3.10 and above.
This set-up assumes you have a fresh Python environment with Python 3.10 and above, e.g.

```bash
pyenv install 3.10
pyenv virtualenv 3.10 cc-changelog-gen-3.10 &&
pyenv activate cc-changelog-gen-3.10
```

First run the following to get `pip-tools` and upgrade other relevant tools:

Expand Down Expand Up @@ -59,9 +64,14 @@ major changes will be tagged.)

Refer to the example [`.clog.yaml`](.clog.yaml) for usage at the moment.

## CLI Example
## CLI Install

If you prefer to install the CLI within its own Python environment, you might want to follow the
`pyenv` set-up in the earlier [Developer Set-up](#developer-set-up), before coming back to this
section.

You will need to install the package first. To do so locally (if you git-cloned the repository):
Once you are in your preferred environment, you will need to install the package first. To do so
locally (if you git-cloned the repository):

```bash
pip install -e .
Expand Down

0 comments on commit fecb922

Please sign in to comment.