Skip to content

Commit

Permalink
Update CONTRIBUTING.md and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dyve committed Dec 10, 2024
1 parent def6462 commit 5965c9c
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
11 changes: 5 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,29 +47,28 @@ You will need some knowledge of git, github, and Python/Django development. Usin

### Local installation

This section assumes you know about local Python versions and virtual environments.
This package uses [uv](https://github.com/astral-sh/uv) and [just](https://github.com/casey/just).

To clone the repository and install the requirements for local development:
After installing both, check out this repository and type `just bootstrap` to bootstrap a development environment.

```console
git clone git://github.com/zostera/django-bootstrap5.git
cd django-bootstrap5
pip install -U pip -r requirements-dev.txt
pip install -e .
just bootstrap
```

### Running the tests

To run the tests:

```console
make test
just test
```

To run the tests on all supported Python/Django combinations:

```console
make tests
just tests
```

## Pull Request Guidelines
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ This package requires a combination of Python and Django that is currently suppo

See "Supported Versions" on https://www.djangoproject.com/download/.

This package uses [uv](https://github.com/astral-sh/uv) and [just](https://github.com/casey/just) for local development.

## Documentation

The full documentation is at https://django-bootstrap5.readthedocs.io/
Expand Down Expand Up @@ -64,7 +66,7 @@ The full documentation is at https://django-bootstrap5.readthedocs.io/
An example app is provided in the folder `example`. You can run the example app with this command:

```console
make example
just example
```

## Bugs and suggestions
Expand Down

0 comments on commit 5965c9c

Please sign in to comment.