Browse Source

update readme

pull/5687/head
Devon Rueckner 2 years ago
parent
commit
0bc3d5b2c0
  1. 19
      README.md

19
README.md

@ -10,15 +10,13 @@
[![User docs](https://img.shields.io/badge/docs-user-blue.svg)](http://kolibri.readthedocs.org/en/latest/)
[![Discourse topics](https://img.shields.io/discourse/https/community.learningequality.org/topics.svg?color=blue)](https://community.learningequality.org/)
These docs are for software developers wishing to contribute to Kolibri. If you are looking for help installing, configuring and using Kolibri, please refer to the [User Guide](https://kolibri.readthedocs.io/).
This repository is for software developers wishing to contribute to Kolibri. If you are looking for help installing, configuring and using Kolibri, please refer to the [User Guide](https://kolibri.readthedocs.io/).
## What is Kolibri?
Kolibri is a Learning Management System / Learning App designed to run on low-power devices, targeting the needs of learners and teachers in contexts with limited infrastructure. A user can install Kolibri and serve the app on a local network, without an internet connection. Kolibri installations can be linked to one another, so that user data and content can be shared. Users can create content for Kolibri and share it when there is network access to another Kolibri installation or the internet.
At its core, Kolibri is about serving educational content. A typical user (called a Learner) will log in to Kolibri to consume educational content (videos, documents, other multimedia) and test their understanding of the content by completing exercises and quizzes, with immediate feedback. A user’s activity will be tracked to offer individualized insight (like "next lesson" recommendations), and to allow user data to be synced across different installations – thus a Kolibri learner can use his or her credentials on any linked Kolibri installation, for instance on different devices at a school.
## What is Kolibri?
See [our website](https://learningequality.org/kolibri/) for more information.
[Kolibri](https://learningequality.org/kolibri/) is the offline learning platform
from [Learning Equality](https://learningequality.org/).
## How can I use it?
@ -26,6 +24,13 @@ See [our website](https://learningequality.org/kolibri/) for more information.
Kolibri is [available for download](https://learningequality.org/download/) from our website.
## How do I get help or give feedback?
You can ask questions, make suggestions, and report issues in the [community forums](https://community.learningequality.org/).
If you have found a bug and are comfortable using Github and Markdown, you can create a [Github issue](https://github.com/learningequality/kolibri/issues) following the instructions in the issue template.
## How can I contribute?
Thanks for your interest! Please see the 'contributing' section of our [online developer documentation](http://kolibri-dev.readthedocs.io/).
Please see the 'contributing' section of our [developer documentation](http://kolibri-dev.readthedocs.io/).

Loading…
Cancel
Save