Part of edX code.

EdX Repository Skeleton

A skeleton that can be used as the basis for open-source edX repositories. To use this for your repo:

• Copy the files in the root to the root of your repo.
• Decide whether you are using the AGPL or Apache license. If you are unsure, read Open edX Licensing or ask the open source team.
  • If your repo is AGPL-licensed, copy the files in the agpl directory to your root.
  • If your repo is Apache-licensed, copy the files in the apache directory to your root.
• Edit all the files to make them appropriate for your repo.

[your readme begins below here:]

Repository Name

The README.rst file, should start with a brief description of the repository which sets it in the context of other repositories under the edx organization. It should make clear where this fits in to the overall edX codebase.

Overview (please modify)

The README.rst file should then provide an overview of the code in this repository, what the main components are and useful entry points for starting to understand the code in more detail.

Getting Started (please modify)

The README.rst file should include a quick guide to getting up and running. This should be the simplest set of steps just to show that things are working.

Documentation (please modify)

The docs for XXX is on Read The Docs: https://XXX.readthedocs.org

License

The code in this repository is licensed under LICENSE_TYPE unless otherwise noted.

Please see LICENSE.txt for details.

How To Contribute

Contributions are very welcome.

Please read How To Contribute for details.

Even though it was written with edx-platform in mind, the guidelines should be followed for Open edX code in general.

Reporting Security Issues

Please do not report security issues in public. Please email security@edx.org

Mailing List and IRC Channel

You can discuss this code on the edx-code Google Group or in the #edx-code IRC channel on Freenode.