Skip to content

Commit

Permalink
docs: update to generalize for both lms and cms
Browse files Browse the repository at this point in the history
  • Loading branch information
asajjad2 committed Feb 12, 2025
1 parent 490025c commit 2e2f118
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,21 @@ This repository contains a collection of Open edX plugins that provide various c

### Installation Guide

Note: Each plugin may require installation in LMS, Studio (CMS), or both environments. Please check the individual plugin's documentation for specific requirements.

You can install any plugin from this collection using one of the following methods:

#### Option 1: Install from PyPI

The simplest way to install a plugin is directly from PyPI. If you're running devstack in Docker, first open a shell in LMS:
The simplest way to install a plugin is directly from PyPI. If you're running devstack in Docker, first open a shell as per requirement and then install the desired plugin using pip:

```bash
# For LMS installation
make lms-shell
```

Then install the desired plugin using pip:
pip install <plugin-name>

```bash
# For Studio (CMS) installation
make studio-shell
pip install <plugin-name>
```

Expand Down

0 comments on commit 2e2f118

Please sign in to comment.