Skip to content

Commit

Permalink
Merge pull request #2 from MCGallaspy/make-readme
Browse files Browse the repository at this point in the history
Add readme and license stubs
  • Loading branch information
aronasorman committed Jan 19, 2016
2 parents 412a22a + 83507f0 commit cf5e19c
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,6 @@ docs/_build/

# PyBuilder
target/

# PyCharm
.idea
18 changes: 18 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Copyright for the Kolibri software, except where otherwise specified in the code or further down in this file, belongs
to the Foundation for Learning Equality, Inc. (FLE), and by contributing your code to this project (except where
otherwise negotiated), you agree to assign copyright in this code to FLE, to be licensed under the same terms as the
rest of the code. The Kolibri codebase is released for use under the open-source MIT license
(see http://opensource.org/licenses/MIT):

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
34 changes: 34 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
What is Kolibri?
----------------

Kolibri is an adaptable measured learning environment. 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.

How can I contribute?
---------------------

Join the mailing list: dev (at) learningequality (dot) org

The project is just starting, but we want the entire development process, from conception to realization, to be carried
out in the open. More will be added to this section in the very near future!

Documentation
-------------

Development documentation is in our `Google Drive <https://drive.google.com/open?id=0B-uSasYw3d7la01HeTlBWl9xdEk>`_,
which you can view and comment on.

You may wish to start with the following documents:

* `Introduction to Learning Equality Software <https://docs.google.com/a/learningequality.org/document/d/1LJmDRsjUBIDjEZDBhHwBjggtTJLrwQy-2gnKLVrMQy8/edit?usp=drive_web>`_
* `Our governance model <https://drive.google.com/open?id=1Hebvda2YIMed__MDDVrg1iJav2YHK4zYEXJ59ITmCcE>`_
* `The Kolibri dev bible <https://drive.google.com/open?id=1s8kqh1NSbHlzPCtaI1AbIsLsgGH3bopYbZdM1RzgxN8>`_, which aims to be the authoritative guide to Kolibri.

0 comments on commit cf5e19c

Please sign in to comment.