mirror of
https://github.com/ChristianLight/tutor.git
synced 2024-09-19 16:09:02 +00:00
b4e3c43902
- More concise table of contents - New intro - Simpler make commands - Fix a couple typos here and there - Get rid of the default github issue template, and start using the template created online.
51 lines
1.4 KiB
ReStructuredText
51 lines
1.4 KiB
ReStructuredText
.. include:: ../README.rst
|
|
:start-after: _readme_intro_start:
|
|
:end-before: _readme_intro_end:
|
|
|
|
.. image:: ./img/quickstart.gif
|
|
:alt: Tutor local quickstart
|
|
:target: https://terminalizer.com/view/91b0bfdd557
|
|
|
|
----------------------------------
|
|
|
|
.. include:: quickstart.rst
|
|
:start-line: 1
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: User guide
|
|
|
|
intro
|
|
install
|
|
quickstart
|
|
configuration
|
|
local
|
|
k8s
|
|
dev
|
|
extra
|
|
troubleshooting
|
|
tutor
|
|
faq
|
|
|
|
Source code
|
|
-----------
|
|
|
|
The complete source code for Tutor is available on Github: https://github.com/regisb/tutor
|
|
|
|
.. include:: ../README.rst
|
|
:start-after: _readme_support_start:
|
|
:end-before: _readme_support_end:
|
|
|
|
.. include:: ../README.rst
|
|
:start-after: _readme_contributing_start:
|
|
:end-before: _readme_contributing_end:
|
|
|
|
License
|
|
-------
|
|
|
|
This work is licensed under the terms of the `GNU Affero General Public License (AGPL) <https://github.com/regisb/tutor/blob/master/LICENSE.txt>`_.
|
|
|
|
The AGPL license covers the Tutor code, including the Dockerfiles, but not the content of the Docker images which can be downloaded from https://hub.docker.com. Software other than Tutor provided with the docker images retain their original license.
|
|
|
|
The :ref:`Tutor Web UI <webui>` depends on the `Gotty <https://github.com/yudai/gotty/>`_ binary, which is provided under the terms of the `MIT license <https://github.com/yudai/gotty/blob/master/LICENSE>`_.
|