From 561abf9d1c7ab15fcafde8cce904cfc2bf26a6de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mar=C3=ADa=20Fernanda=20Magallanes?= <35668326+MaferMazu@users.noreply.github.com> Date: Wed, 3 Jan 2024 11:40:59 -0400 Subject: [PATCH] docs: consistency in commands and the need for themes root (#56) --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b58229d..0caa62a 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ This can be watch like a tutor-plugin but is taken a little bit far away. ## Installation ```bash -pip install git+https://github.com/eduNEXT/tutor-contrib-edunext-distro@v15.2.0 +pip install git+https://github.com/eduNEXT/tutor-contrib-edunext-distro ``` ## Usage @@ -18,12 +18,12 @@ pip install git+https://github.com/eduNEXT/tutor-contrib-edunext-distro@v15.2.0 tutor plugins enable distro # Validator commands for config file -tutor distro syntax_validator +tutor distro syntax-validator tutor distro repository-validator # Enabler commands tutor distro enable-themes -tutor distro enable_private_packages +tutor distro enable-private-packages ``` ### Documentation @@ -146,6 +146,16 @@ DISTRO_THEMES_NAME: - bragi ``` +Set themes root (which is where the theme will be installed): + +When you set the ``DISTRO_THEMES_ROOT``, the theme will be in your ``/env/build``. + +```yaml +DISTRO_THEMES_ROOT: /openedx/themes +``` + +In the previous example, the theme will be in ``env/build/openedx/themes`` when you execute the ``enable-themes`` command. + Run the command to clone the themes: ```bash