RELATE

RELATE
======

Relate is an Environment for Learning And TEaching

.. image:: https://gitlab.tiker.net/inducer/relate/badges/main/pipeline.svg
    :alt: Gitlab Build Status
    :target: https://gitlab.tiker.net/inducer/relate/commits/main
.. image:: https://github.com/inducer/relate/actions/workflows/CI.yml/badge.svg
    :alt: Github Build Status
    :target: https://github.com/inducer/relate/actions/workflows/CI.yml
.. image:: https://badge.fury.io/py/relate-courseware.png
    :alt: Python Package Index Release Page
    :target: https://pypi.org/project/relate-courseware/

+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| .. image:: https://raw.githubusercontent.com/inducer/relate/main/doc/images/screenshot.png | .. image:: https://raw.githubusercontent.com/inducer/relate/main/doc/images/screenshot-2.png |
+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+

RELATE is a web-based courseware package.  It is set apart by the following
features:

* Focus on easy content creation

  * Simple, text-based format for reusable course content
  * Based on standard `YAML <https://en.wikipedia.org/wiki/YAML>`_,
    `Markdown <https://en.wikipedia.org/wiki/Markdown>`_

  See `example content <https://github.com/inducer/relate-sample>`_.

* Flexible rules for participation, access, and grading
* Versioning of content through deep integration with `git <https://git-scm.org>`_.
  Instructors can preview newly-authored content while students work with
  prior versions, all from the same instance of RELATE.
* Multiple courses can be hosted on the same installation
* Code questions:

  * Allow students to write code into a text box (with syntax highlighting)
  * Sandboxed execution
  * Automatic grading
  * Plotting support
  * Optional second-stage grading by a human

* Class calendar and grade book functionality.
* Statistics/analytics of student answers.
* Facilitates live quizzes in the classroom.
* In-class instant messaging via XMPP.
  Works well with `xmpp-popup <https://github.com/inducer/xmpp-popup>`_.

Links
-----

More information around the web:

* `Documentation <http://documen.tician.de/relate>`_
* `Source code <https://github.com/inducer/relate>`_

Installation
------------

See the `installation guide <http://documen.tician.de/relate/misc.html#installation>`_.

License
-------

Copyright (C) 2014-15 Andreas Kloeckner

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.