diff --git a/README.md b/README.md index 8cd5f7d..53ae1dc 100644 --- a/README.md +++ b/README.md @@ -2,21 +2,41 @@ ## Installation -Follow these steps to initialize a development environment: +Currently, this repository does only contain a plain `Django` app without a +project. The app is not (yet) packaged. Therfore, the following steps are +necessary to initialize a development environment: - 1. Initialize _Django_ project + 1. Initialize _Django_ project: ``` django startproject PROJECT_NAME ``` - 2. Add `bam` to `INSTALLED_APPS` in the project's `settings.py` - 3. Append `path('', include('bam.urls')),` to the project's `urls.py` - 4. Initialize database + + 2. Clone this repository to a location outside the project directory. + + 3. Below the project directory, create a symlink called `bam` to the `bam` + folder of this repository, e.g.: + + ``` + ln -sr bam PROJECT_DIRECTORY/bam + ``` + + 4. Add `bam` to `INSTALLED_APPS` in the project's `settings.py`. + + 5. Append `path('', include('bam.urls')),` to the project's `urls.py`. + + 6. Initialize database: ``` ./manage.py migrate ``` + 7. Create a superuser account: + + ``` + ./manage.py createsuperuser + ``` + ## ToDo ### Essential @@ -29,3 +49,5 @@ Follow these steps to initialize a development environment: * service-based logins * self-service registration + * package this app as a _Python_ module +