Skip to content

Commit

Permalink
README fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
mrsarm committed Sep 2, 2024
1 parent 6176adb commit 1786ca1
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Requirements

Docker, or:

* Python 3.8+ (tested with Python 3.8 and 3.11).
* Python 3.10+ (tested with 3.11).
* Django 4.2 LTS and other dependencies declared in
the ``requirements.txt`` file (use virtual environments or containers!).
* A Django compatible database like PostgreSQL (by default uses
Expand Down Expand Up @@ -125,8 +125,9 @@ in `Docker Hub <https://hub.docker.com/r/mrsarm/django-coleman>`_.

Also ``compose.yaml`` and ``.env.example`` files are provided in the
`dcoleman-e2e <https://github.com/mrsarm/dcoleman-e2e>`_ project, you
can run all from there, Django Coleman, the viewer app and Postgres,
and the E2E tests.
can run all from there, Django Coleman, the
`viewer <https://github.com/mrsarm/tornado-dcoleman-mtasks-viewer>`_ app
and Postgres, and the E2E tests.

First, copy the ``.env.example`` file as ``.env`` files from the E2E repo,
and edit whatever value you want to::
Expand Down Expand Up @@ -200,10 +201,11 @@ set *debug* options to false::
$ DEBUG=False LANGUAGE_CODE=es-ar python3 manage.py runserver

Also in development environments an ``.env`` file can be used to setup
the environment variables easily, checkout the `<.env.example>`_ as example.
the environment variables easily, checkout the
`.env.example <https://github.com/mrsarm/dcoleman-e2e/blob/main/.env.example>`_ as example.
You can copy the example file and edit the variables you want to change::

$ cp .env.example .env
$ cp ../dcoleman-e2e/.env.example .env
$ vi .env

Some available settings:
Expand Down

0 comments on commit 1786ca1

Please sign in to comment.