tutor/README.rst

40 lines
1.7 KiB
ReStructuredText
Raw Normal View History

2018-12-26 15:00:47 +00:00
Tutor 🎓 Open edX 1-click install for everyone
==============================================
.. image:: https://img.shields.io/travis/regisb/tutor.svg
2018-12-26 15:00:47 +00:00
:alt: Build status
:target: https://travis-ci.org/regisb/tutor
2018-12-26 15:00:47 +00:00
.. image:: https://img.shields.io/github/issues/regisb/tutor.svg
2018-12-26 15:00:47 +00:00
:alt: GitHub issues
:target: https://github.com/regisb/tutor/issues
2018-12-26 15:00:47 +00:00
.. image:: https://img.shields.io/github/issues-closed/regisb/tutor.svg?colorB=brightgreen
2018-12-26 15:00:47 +00:00
:alt: GitHub closed issues
:target: https://github.com/regisb/tutor/issues?q=is%3Aclosed
2018-12-26 15:00:47 +00:00
**Tutor** is a one-click install of `Open edX <https://openedx.org>`_, both for production and local development, inside docker containers. Tutor is easy to run, fast, full of cool features, and it is already used by dozens of Open edX platforms in the world.
2018-12-27 01:49:12 +00:00
.. image:: https://asciinema.org/a/octNfEnvIA6jNohCBmODBKizE.png
2018-12-26 15:00:47 +00:00
:alt: asciicast
2018-12-27 01:49:12 +00:00
:target: https://asciinema.org/a/octNfEnvIA6jNohCBmODBKizE
2018-12-26 15:00:47 +00:00
Quickstart
----------
::
git clone https://github.com/regisb/tutor
2018-12-27 00:28:40 +00:00
cd tutor/deploy/local
make all
2018-12-26 15:00:47 +00:00
Documentation
-------------
2018-12-28 15:52:33 +00:00
Extensive documentation is available online: http://docs.tutor.overhang.io/
2018-12-26 15:00:47 +00:00
How to contribute
-----------------
We go to great lengths to make it as easy as possible for people to run Open edX inside Docker containers. If you have an improvement idea, feel free to `open an issue on Github <https://github.com/regisb/tutor/issues/new>`_ so that we can discuss it. `Pull requests <https://github.com/regisb/tutor/pulls>`_ will be happily examined, too! However, we should be careful to keep the project lean and simple: both to use and to modify. Optional features should not make the user experience more complex. Instead, documentation on how to add the feature is preferred.