From 3aca32c49ccfcd990211bdc1c464e95e8f02628f Mon Sep 17 00:00:00 2001 From: Edward Zarecor Date: Tue, 16 Aug 2022 09:29:35 -0400 Subject: [PATCH] fix: initial efforts to create useful, standard readme with purpose. --- README.rst | 32 +++++++++++++++++++++++++++++--- 1 file changed, 29 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 9132a748dc..4b5a7648b2 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,32 @@ -This is the core repository of the Open edX software. It includes the LMS -(student-facing, delivering courseware), and Studio (course authoring) -components. +############ +edX Platform +############ +| |License: AGPL v3| |Status| |Python CI| |Publish package to PyPi| + +.. |License: AGPL v3| image:: https://img.shields.io/badge/License-AGPL_v3-blue.svg + :target: https://www.gnu.org/licenses/agpl-3.0 + +.. |Python CI| image:: https://github.com/openedx/edx-platform/actions/workflows/ci.yml/badge.svg + :target: https://github.com/openedx/edx-platform/actions/workflows/ci.yml + +.. |Publish package to PyPi| image:: https://github.com/openedx/edx-platform/actions/workflows/pypi-release.yml/badge.svg + :target: https://github.com/openedx/edx-platform/actions/workflows/pypi-release.yml + +.. |Status| image:: https://img.shields.io/badge/status-maintained-31c653 + +Purpose +======= +The Open edX platform is a service oriented platform for authoring and +delivering online learning at any scale. The platform is written in +Python and JavaScript and makes extensive use of the Django +framework. At the highest level, the platform is composed of a +monolith, some independently deployable applications (IDAs), and +micro-frontends (MFEs) based on the ReactJS. + +This repository hosts the monolith at the center of the Open edX +platform. Functionally, the edx-platform repository provides the +environment for authoring courses, Open edX Studio, also called the +CMS, and the course delivery service, called the LMS. Installation ------------