Skip to content
This repository was archived by the owner on Sep 5, 2023. It is now read-only.

Commit cb2a0bb

Browse files
committed
docs(README): Fix install instructions
1 parent 1d8f954 commit cb2a0bb

File tree

1 file changed

+27
-20
lines changed

1 file changed

+27
-20
lines changed

README.md

+27-20
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
<a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black" height="18"></a>
99
</p>
1010

11-
1211
# Install
1312

1413
To install
@@ -28,6 +27,7 @@ gitcommit
2827
The purpose of this utility is to expedite the process of committing with a conventional message format in a user friendly way. This tool is not templated, because it sticks rigidly to the [Conventional Commit standard](https://www.conventionalcommits.org), and thus not designed to be 'altered' on a case by case basis.
2928

3029
Commit messages produced follow the general template:
30+
3131
```
3232
<type>[(optional scope)]: <description>
3333
@@ -47,7 +47,7 @@ Additional rules implemeted:
4747
The old distribution method is documented in
4848
[docs/dev_distibution_legacy.md](docs/dev_distribution_legacy.md)
4949

50-
*Note: if modifying `.travis.yml` you should verify it by running `travis lint .travis.yml`*
50+
_Note: if modifying `.travis.yml` you should verify it by running `travis lint .travis.yml`_
5151

5252
## Getting started
5353

@@ -62,33 +62,35 @@ The old distribution method is documented in
6262
1. `pre-commit install`
6363

6464
1. It is highly recommend you enable setting for storing the venvs within your projects.
65-
```
66-
poetry config settings.virtualenvs.in-project true
67-
```
65+
66+
```
67+
poetry config virtualenvs.in-project true
68+
```
6869

6970
1. Install project dependencies.
70-
```
71-
poetry install
72-
```
71+
```
72+
poetry install
73+
```
7374

7475
## Running the package locally
7576

7677
1. Activate the virtual environment.
77-
```
78-
source .venv/bin/activate
79-
```
78+
79+
```
80+
source .venv/bin/activate
81+
```
8082

8183
1. Run the package as a module.
82-
```
83-
python -m gitcommit
84-
```
84+
```
85+
python -m gitcommit
86+
```
8587

8688
Alternatively,
8789

8890
1. Run the package using Poetry's venv as context
89-
```
90-
poetry run python -m gitcommit
91-
```
91+
```
92+
poetry run python -m gitcommit
93+
```
9294

9395
Or, if in another directory,
9496

@@ -99,17 +101,22 @@ Or, if in another directory,
99101
## Deploy
100102
101103
Deployment is handled automatically by Travis CI. It has been linked to the
102-
repository and is automatically watching for pushes to master. It will build and
103-
test every commit to master. It will also build every tagged commit as if it was
104-
a branch, and since its a tagged commit, will attempt to publish it to PyPI.
104+
repository and is automatically watching for pushes to master. It will build
105+
and test every commit to master. It will also build every tagged commit as
106+
if it was a branch, and since its a tagged commit, will attempt to publish
107+
it to PyPI.
105108
106109
1. Don't forget to increment version number set in `pyproject.toml`. This can be
107110
done with poetry.
111+
108112
```
109113
poetry version [patch|minor|major]
110114
```
111115
116+
1. Update the version number as stored in the `gitcommit/__version__.py` file to match that designated by Poetry.
117+
112118
1. Tag the commit (by default applies to HEAD commit - make sure you are on the latest `develop` commit).
119+
113120
```
114121
git tag v#.#.#
115122
```

0 commit comments

Comments
 (0)