From 62ecf6dde9d79b37ec40c5e329adcbe738ebff0c Mon Sep 17 00:00:00 2001 From: Tim McCormack Date: Mon, 28 Sep 2020 13:25:11 -0400 Subject: [PATCH] Add README explaining normal/codejail requirements split (#25037) --- requirements/README.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 requirements/README.rst diff --git a/requirements/README.rst b/requirements/README.rst new file mode 100644 index 0000000000..1855331536 --- /dev/null +++ b/requirements/README.rst @@ -0,0 +1,10 @@ +These directories specify the Python (and system) dependencies for the LMS and Studio. + +- ``edx`` contains the normal Python requirements files +- ``edx-sandbox`` contains the requirements files for Codejail +- ``constraints.txt`` is shared between the two + +(In a normal `OEP-18`_-compliant repository, the ``*.in`` and ``*.txt`` files would be +directly in the requirements directory.) + +.. _OEP-18: https://github.com/edx/open-edx-proposals/blob/master/oeps/oep-0018-bp-python-dependencies.rst