6
0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-14 01:04:09 +00:00
tutor/README.rst

55 lines
2.4 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
2019-02-20 12:52:25 +00:00
.. image:: https://img.shields.io/badge/docs-current-brightgreen.svg
:alt: Documentation
:target: https://docs.tutor.overhang.io
2019-02-19 21:37:59 +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
.. image:: https://img.shields.io/github/license/regisb/tutor.svg
:alt: AGPL License
:target: https://www.gnu.org/licenses/agpl-3.0.en.html
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.
.. image:: ./docs/img/quickstart.gif
:alt: Tutor local quickstart
:target: https://terminalizer.com/view/91b0bfdd557
2018-12-26 15:00:47 +00:00
Quickstart
----------
2019-02-18 08:53:54 +00:00
1. `Download <https://github.com/regisb/tutor/releases>`_ the latest stable release of Tutor, uncompress the file and place the ``tutor`` executable in your path. From the command line::
sudo curl -L "https://github.com/regisb/tutor/releases/download/latest/tutor-$(uname -s)_$(uname -m)" -o /usr/local/bin/tutor
sudo chmod +x /usr/local/bin/tutor
2. Run ``tutor local quickstart``
3. You're done!
2018-12-26 15:00:47 +00:00
Documentation
-------------
2019-02-20 12:52:25 +00:00
Extensive documentation is available online: https://docs.tutor.overhang.io/
2018-12-26 15:00:47 +00:00
2019-02-19 21:26:43 +00:00
Support
-------
To get community support, go to the official discussion forums: https://discuss.overhang.io.
Contributing
------------
2018-12-26 15:00:47 +00:00
2019-02-19 21:26:43 +00:00
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 first discuss it on the `Tutor forum <https://discuss.overhang.io>`_. Did you find an issue with Tutor? Please first make sure that it's related to Tutor, and not an issue with Open edX. Then, `open an issue on Github <https://github.com/regisb/tutor/issues/new>`_. `Pull requests <https://github.com/regisb/tutor/pulls>`_ will be happily examined, too!