docs: 📝 Update README.rst with better explanations and formatting + fix broken link

This commit is contained in:
Benbb96 2024-03-11 17:09:10 +01:00
parent ceb137eb97
commit cc74b82dee
No known key found for this signature in database

View File

@ -28,11 +28,11 @@ get started with testing or developing `django-helpdesk`. The demo project
resides in the `demo/` top-level folder.
It's likely that you can start up a demo project server by running
only the command:
only the command (consider creating a virtualenv before):
make rundemo
or with docker:
or with docker::
docker build . -t demodesk
docker run --rm -v "$PWD:/app" -p 8080:8080 demodesk
@ -74,27 +74,33 @@ Developer Environment
Follow these steps to set up your development environment to contribute to helpdesk:
- check out the helpdesk app to your 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
- install a virtual environment and activate it::
python -m venv .venv && source .venv/bin/activate
- install the requirements for development::
pip install -r requirements.txt -r requirements-dev.txt
- install the requirements for testing as well::
pip install -r requirements.txt -r requirements-dev.txt -r requirements-testing.txt
- you can install the requirements for testing as well::
pip install -r requirements-testing.txt
To deactivate the virtual environment, use ``deactivate``. Then to reactivate it, just run::
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::
make checkformat
To auto format any code use this::
make format
Testing
@ -145,5 +151,5 @@ Note that django-helpdesk is distributed with 3rd party products which
have their own licenses. See LICENSE.3RDPARTY for license terms for
included packages.
.. _note: http://docs.djangoproject.com/en/dev/ref/databases/#sqlite-string-matching
.. _note: https://docs.djangoproject.com/en/dev/ref/databases/#substring-matching-and-case-sensitivity