From 91ad0b47b88ce1d7def539d0ba44a9f6f06a67a1 Mon Sep 17 00:00:00 2001 From: Tom Carrick Date: Sat, 8 Jun 2024 10:19:25 +0200 Subject: [PATCH] Update readme with usage instructions --- README.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.rst b/README.rst index dcda03e..7db81b6 100644 --- a/README.rst +++ b/README.rst @@ -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 -------