Skip to content

Commit

Permalink
Update development documentation and usage instructions
Browse files Browse the repository at this point in the history
- Modified DEVELOPMENT.md to update GitHub username placeholders for consistency in repository cloning and issue tracking links.
- Updated README.md to change the usage command for running the application, reflecting the new entry point structure.

These changes improve clarity and ensure users have accurate instructions for setting up and using the project.
  • Loading branch information
wyattowalsh committed Dec 4, 2024
1 parent 8ef0414 commit 9aeef03
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 21 deletions.
41 changes: 21 additions & 20 deletions {{cookiecutter.project_slug}}/DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,35 +3,36 @@
## Setting Up Your Development Environment

1. **Clone the repository**:
```bash
git clone https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}.git
cd {{ cookiecutter.project_slug }}
```

```bash
git clone https://github.com/{{ cookiecutter.author_github_username }}/{{ cookiecutter.project_slug }}.git
cd {{ cookiecutter.project_slug }}
```
2. **Install dependencies**:
```bash
poetry install
```

```bash
poetry install
```
3. **Activate the development environment**:
```bash
poetry shell
```

```bash
poetry shell
```
4. **Run the test suite**:
```bash
poetry run pytest
```

```bash
poetry run pytest
```
5. **Format and lint code**:
```bash
poetry run black .
poetry run flake8
```

```bash
poetry run black .
poetry run flake8
```

## Issue Tracking and Contributions

Please refer to our [Issue Templates](https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/issues/new/choose) to submit or contribute to:
Please refer to our [Issue Templates](https://github.com/{{ cookiecutter.author_github_username }}/{{ cookiecutter.project_slug }}/issues/new/choose) to submit or contribute to:

- [Bug Reports](https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/issues/new?template=bug_report.md)
- [Feature Requests](https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/issues/new?template=feature_request.md)
- [Bug Reports](https://github.com/{{ cookiecutter.author_github_username }}/{{ cookiecutter.project_slug }}/issues/new?template=bug_report.md)
- [Feature Requests](https://github.com/{{ cookiecutter.author_github_username }}/{{ cookiecutter.project_slug }}/issues/new?template=feature_request.md)
2 changes: 1 addition & 1 deletion {{cookiecutter.project_slug}}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ poetry install
## Usage

```bash
poetry run python {{ cookiecutter.entry_point }}
poetry run python -m {{ cookiecutter.project_slug }}
```

## Development
Expand Down

0 comments on commit 9aeef03

Please sign in to comment.