Skip to content

Commit

Permalink
Update README.md (#586)
Browse files Browse the repository at this point in the history
  • Loading branch information
dyve authored Dec 11, 2024
1 parent 31c0fee commit 236e76d
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,23 +81,24 @@ See "Supported Versions" on <https://www.djangoproject.com/download/>.

## Local installation

**This section assumes you know about local Python versions and virtual environments.**
### Local installation

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:

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

### Running the demo

You can run the example app:

```shell
cd example && run python manage.py runserver
just example
```

### Running the tests
Expand All @@ -111,7 +112,7 @@ tox
Test for the current environment can be run with the Django `manage.py` command.

```shell
python manage.py test
just test
```

## Origin
Expand Down

0 comments on commit 236e76d

Please sign in to comment.