diff --git a/README.md b/README.md index 4d80dd9fb11c0d5e44089c2dcf4aa7c4a1a4ae21..971451ac56e9be17fa96c1d6fd8920e5774198ac 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,74 @@ A module handling basic fonctionnality needed in django project such as base.html using bootstrap, account settings, preferences management, ... -# Cheat sheet +# Quick start + +1. Add "basetheme_bootstrap" to your INSTALLED_APPS setting like this (while not forgetting `crispy_forms`) + +```python +INSTALLED_APPS = [ + ... + 'crispy_forms', + 'basetheme_bootstrap', +] +``` + +2. Add the context_processors:: + +```python +TEMPLATES = [ + { + 'BACKEND': 'django.template.backends.django.DjangoTemplates', + 'DIRS': [], + 'APP_DIRS': True, + 'OPTIONS': { + 'context_processors': [ + ... + 'basetheme_bootstrap.context_processors.processors', + ], + }, + }, +] +``` + +3. Adjust the configuration:: + + +```python +################################################################################ +# django-crispy-forms +################################################################################ +CRISPY_TEMPLATE_PACK = 'bootstrap4' + +################################################################################ +# basetheme_bootstrap +################################################################################ +BASETHEME_BOOTSTRAP_TEMPLATE_LOCATION_PROJECT = "test_app_1" +BASETHEME_BOOTSTRAP_USER_PREFERENCE_MODEL_ENABLED = True +BASETHEME_BOOTSTRAP_USER_PREFERENCE_MODEL_LOCATION_APP = "test_app_1" +BASETHEME_BOOTSTRAP_USER_PREFERENCE_MODEL_NAME = "MyUserPreferences" +################################################################################ ``` + +3. Include the polls URLconf in your project urls.py like this:: + +```python +from django.urls import path, include + +path('', include('basetheme_bootstrap.urls')), +``` + +3. Run `python manage.py migrate` to create the UserPreferences model if you decided to have one. + +4. Make your templates extends base template from`basetheme_bootstrap`, or even better create your own base.html which extends the one from `basetheme_bootstrap`:: + +```html +{% extends "basetheme_bootstrap/base4.html" %} +``` + +# Cheat sheet + +```bash mkdir -p locale && python manage.py makemessages -l en -l fr --no-location && rm -rf ./locale ``` \ No newline at end of file diff --git a/README.rst b/README.rst index 636f87dff3e97e93a36e876ee62d162a90dd66db..9d4095d905a34c8dda224e13e0265bb953a4485c 100644 --- a/README.rst +++ b/README.rst @@ -53,6 +53,8 @@ Quick start 3. Include the polls URLconf in your project urls.py like this:: + from django.urls import path, include + path('', include('basetheme_bootstrap.urls')), 3. Run `python manage.py migrate` to create the UserPreferences model if you decided to have one.