diff --git a/README.rst b/README.rst index fdf57f4..3d51ed6 100644 --- a/README.rst +++ b/README.rst @@ -104,18 +104,27 @@ To enable themes in your Tutor environment, follow these steps: 1. Add the necessary configuration in your Tutor environment's ``config.yml`` file: .. code-block:: yaml - + + PICASSO_TUTOR_VERSION: PICASSO_THEMES: - - name: + - name: repo: version: - - name: + - name: repo: version: + PICASSO_THEMES_NAME: + - + - + PICASSO_THEME_DIRS: + - + - **Note:** If your theme repository is public, you can also use the HTTPS URL in ``repo``. +**Note:** The ``PICASSO_THEMES``, ``PICASSO_THEME_DIRS`` and ``PICASSO_THEMES_NAME`` variables are lists and can have one or more elements. + 2. Save the configuration with ``tutor config save`` 3. Run the enable command @@ -125,7 +134,15 @@ To enable themes in your Tutor environment, follow these steps: # Enable themes tutor picasso enable-themes -This command clones your theme repository into the folder that Tutor uses for themes. Documentation available at `Installing custom theme`_ tutorial. +This command will clone your theme repository into the folder that Tutor uses for themes. You can find the documentation in the `Installing custom theme`_ tutorial. + +If ``PICASSO_THEMES`` is defined, the plugin will set ``ENABLE_COMPREHENSIVE_THEMING = True``. + +If ``PICASSO_THEME_DIRS`` is defined, the plugin will extend the ``COMPREHENSIVE_THEME_DIRS`` by patches. + +The ``PICASSO_TUTOR_VERSION``, ``PICASSO_THEME_DIRS`` and ``PICASSO_THEMES_NAME`` variables are used to compile the themes. For detailed information, see the patch `openedx-dockerfile-pre-assets `_. + +You can set the ``PICASSO_DEFAULT_SITE_THEME`` (optional), which will be in ``DEFAULT_SITE_THEME``; if not, we will use the first element in ``PICASSO_THEMES_NAME``. **Note:** Don't forget to add extra configurations in a Tutor plugin if your theme requires it.