From f1e1d52cd24436dec9a32f0687f6f27a6fc19197 Mon Sep 17 00:00:00 2001 From: Christopher Broderick Date: Sun, 23 Jul 2023 06:23:06 +0100 Subject: [PATCH] Minor enhancement to indicate how to get hrlpdesk setup for development --- README.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 5eae9856..bd6fd6ea 100644 --- a/README.rst +++ b/README.rst @@ -51,7 +51,7 @@ Installation `django-helpdesk` requires: * Python 3.8+ -* Django 3.2 LTS highly recommended (early adopters may test Django 4) +* Django 3.2 LTS or Django 4.* You can quickly install the latest stable version of `django-helpdesk` app via `pip`:: @@ -72,6 +72,9 @@ Developer Environment --------------------- Follow these steps to set up your development environment to contribute to helpdesk: + - check out the helpdesk app to you local file system:: + git clone https://github.com/django-helpdesk/django-helpdesk.git + - install a virtual environment - using virtualenv from the helpdesk base folder do:: virtualenv .venv && source .venv/bin/activate @@ -79,6 +82,9 @@ Follow these steps to set up your development environment to contribute to helpd - install the requirements for development:: pip install -r requirements.txt -r requirements-dev.txt +To reactivate a VENV just run: + source .venv/bin/activate + To see option for the Makefile run: `make` The project enforces a standardized formatting in the CI/CD pipeline. To ensure you have the correct formatting run::