Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme with usage instructions #10

Merged
merged 1 commit into from
Jun 8, 2024
Merged

Update readme with usage instructions #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,23 @@ we could have in the core admin. Most of the work needs to happen in core becaus
we'd likely need to add new blocks to the admin template, and would ideally need
changes to the templates.

Setup
-----

You will need a Django project with the admin enabled. The easiest way is to use
https://github.com/knyghty/django-admin-demo

Then clone this repo somewhere and install it in editable mode with pip, e.g.

```
pip install -e ../django-admin-keyboard-shortcuts
```

Then add `django_admin_keyboard_shortcuts` to your `INSTALLED_APPS`. It must go
above the `django.contrib.admin` app so that the template overrides work.

Now you can hack away.

Credits
-------

Expand Down