Skip to content

Commit

Permalink
docs: consistency in commands and the need for themes root (#56)
Browse files Browse the repository at this point in the history
  • Loading branch information
MaferMazu committed Jan 3, 2024
1 parent 44f3ec1 commit 561abf9
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -18,12 +18,12 @@ pip install git+https://github.com/eduNEXT/[email protected]
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
Expand Down Expand Up @@ -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 ``<tutor_root>/env/build<distro_themes_root>``.
```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
Expand Down

0 comments on commit 561abf9

Please sign in to comment.