Skip to content

Commit

Permalink
Bash syntax highlighting in README
Browse files Browse the repository at this point in the history
  • Loading branch information
simonw authored Mar 11, 2024
1 parent ace9b40 commit 082101a
Showing 1 changed file with 20 additions and 19 deletions.
39 changes: 20 additions & 19 deletions {{cookiecutter.hyphenated}}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,31 +10,32 @@
## Installation

Install this tool using `pip`:

pip install {{ cookiecutter.hyphenated }}

```bash
pip install {{ cookiecutter.hyphenated }}
```
## Usage

For help, run:

{{ cookiecutter.hyphenated }} --help

```bash
{{ cookiecutter.hyphenated }} --help
```
You can also use:

python -m {{ cookiecutter.underscored }} --help

```bash
python -m {{ cookiecutter.underscored }} --help
```
## Development

To contribute to this tool, first checkout the code. Then create a new virtual environment:

cd {{ cookiecutter.hyphenated }}
python -m venv venv
source venv/bin/activate

```bash
cd {{ cookiecutter.hyphenated }}
python -m venv venv
source venv/bin/activate
```
Now install the dependencies and test dependencies:

pip install -e '.[test]'

```bash
pip install -e '.[test]'
```
To run the tests:

pytest
```bash
pytest
```

1 comment on commit 082101a

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.