Skip to content

Commit

Permalink
chore: clean up
Browse files Browse the repository at this point in the history
- Some markdown issues resolved.
- Trailing whitespaces removed.
- tutor setup instructions added.
  • Loading branch information
CodeWithEmad committed Sep 14, 2024
1 parent 8cae871 commit a7993a7
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,21 @@ H5P Xblock provides ability to host and play H5P content in open edX. It has few
3. Save learner state which can be retrieved later
4. Ability to host H5P content on cloud storage like AWS S3

# Setup
## Setup

### Install Xblock

```
```bash
pip install h5p-xblock
```

or if you're using tutor to manage your organization:

```bash
tutor config save --append OPENEDX_EXTRA_PIP_REQUIREMENTS=h5p-xblock
tutor images build openedx
```

### Update Advanced Settings of course

Update course advanced settings by adding `h5pxblock`
Expand All @@ -24,15 +31,13 @@ Update course advanced settings by adding `h5pxblock`

### Upload H5P Content

Xblock should be available in Advanced component list of course unit now. Add xblock in unit and click "Edit" button to
upload H5P content and configure it.
Xblock should be available in Advanced component list of course unit now. Add xblock in unit and click "Edit" button to upload H5P content and configure it.

![Upload and configure H5P content in Studio](https://github.com/edly-io/h5pxblock/blob/master/docs/images/upload_content.png?raw=true)

### Publish Content

Use "Preview" button to preview it or publish your content and use "View Live Version" button to see how it appears
on LMS
Use "Preview" button to preview it or publish your content and use "View Live Version" button to see how it appears on LMS

![Preview H5P content in LMS](https://github.com/edly-io/h5pxblock/blob/master/docs/images/preview_content.png?raw=true)

Expand All @@ -55,7 +60,7 @@ H5PXBLOCK_STORAGE = {

Please ensure that your bucket is publicly accessible to enable seamless content storage and retrieval via S3.

# Working with translations
## Working with translations

You can help by translating this project. Follow the steps below:

Expand Down

0 comments on commit a7993a7

Please sign in to comment.