Skip to content
README.rst 3.65 KiB
Newer Older
RELATE
======

Relate is an Environment for Learning And TEaching
Dong Zhuang's avatar
Dong Zhuang committed

.. image:: https://travis-ci.org/inducer/relate.svg?branch=master
  :target: https://travis-ci.org/inducer/relate

.. image:: https://ci.appveyor.com/api/projects/status/d5bigdw90bxnfdgy?svg=true
  :target: https://ci.appveyor.com/project/inducer/relate

.. image:: https://codecov.io/gh/inducer/relate/branch/master/graph/badge.svg
  :target: https://codecov.io/gh/inducer/relate/commits

Andreas Klöckner's avatar
Andreas Klöckner committed
+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| .. image:: https://raw.githubusercontent.com/inducer/relate/master/doc/images/screenshot.png | .. image:: https://raw.githubusercontent.com/inducer/relate/master/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>`_
Andreas Klöckner's avatar
Andreas Klöckner committed
  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
Andreas Klöckner's avatar
Andreas Klöckner committed
  prior versions, all from the same instance of RELATE.
* Multiple courses can be hosted on the same installation
* Code questions:
Andreas Klöckner's avatar
Andreas Klöckner committed

  * Allow students to write code into a text box (with syntax highlighting)
Andreas Klöckner's avatar
Andreas Klöckner committed
  * Sandboxed execution
  * Automatic grading
  * Plotting support
  * Optional second-stage grading by a human
Andreas Klöckner's avatar
Andreas Klöckner committed

* Class calendar and grade book functionality.
* Statistics/analytics of student answers.
* Facilitates live quizzes in the classroom.
Andreas Klöckner's avatar
Andreas Klöckner committed
* In-class instant messaging via XMPP.
Andreas Klöckner's avatar
Andreas Klöckner committed
  Works well with `xmpp-popup <https://github.com/inducer/xmpp-popup>`_.
Andreas Klöckner's avatar
Andreas Klöckner committed
* Built-in support for `VideoJS <http://www.videojs.com/>`_ offers
  easy-to-use support for integrating HTML5 video into course content
  without the need for third-party content hosting.
Andreas Klöckner's avatar
Andreas Klöckner committed
Links
-----

Andreas Klöckner's avatar
Andreas Klöckner committed
More information around the web:

Andreas Klöckner's avatar
Andreas Klöckner committed
* `Documentation <http://documen.tician.de/relate>`_
* `Source code <https://github.com/inducer/relate>`_
Andreas Klöckner's avatar
Andreas Klöckner committed

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

Andreas Klöckner's avatar
Andreas Klöckner committed
See the `installation guide <http://documen.tician.de/relate/misc.html#installation>`_.
Andreas Klöckner's avatar
Andreas Klöckner committed

Andreas Klöckner's avatar
Andreas Klöckner committed
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.