Skip to content
This repository has been archived by the owner on Feb 11, 2025. It is now read-only.

Polish setup documentation in README #240

Closed
wants to merge 3 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ While developing you will probably prefer to swap out
``argus.site.settings.backend`` with ``argus.site.settings.dev``, as the former
is almost production-ready while the latter is tuned for development and
depends on the optional dependencies you can install via ``pip install
argus-server[dev]``.
argus-server[dev]``. This is especially relevant if you want do not
explicitly set the variables ``SECRET_KEY`` and ``STATIC_ROOT``.

The ``argus.site.utils.update_settings`` function will add or change the settings

Expand Down Expand Up @@ -77,7 +78,8 @@ urls.py and set ROOT_URLCONF appropriately.
If you have some other apps you want installed and configured, you could either
add the necessary settings to your ``localsettings.py`` or use the extra-apps
machinery. The later is especially useful during the development phase when you
haven't settled on which apps to use yet.
haven't settled on which apps to use yet, or if you want to test some makeshift
apps in a way that is easy to setup and easy to discard.

With extra-apps machinery
~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -123,11 +125,7 @@ On every new version, reinstall the dependencies since there might be new ones.

Themes and styling
==================

To try out daisyUI themes use the context processor
``argus_htmx.context_processor.theme_via_session`` instead of
``argus_htmx.context_processor.theme_via_GET``.

Argus comes with a set of themes that can be changed on the user preferences page.
Default included themes are: `light`, `dark` and `argus`.

This project supports Tailwind CSS utility classes and daisyUI components for styling.
Expand Down
Loading