## As many of these as you'd like to include, or others if you wish!
Please tag @edx/[YOUR-TEAM] on any PRs or issues. Thanks!
What is this MFE? Add a 2-3 sentence description of what it is and what it does.
What is the _domain_ of this MFE? That is, what is in here, what belongs here? What's _not_ in here that people might think could belong here, but is purposefully excluded?
Add any additional detail/notes relevant to understanding the whats/whys of this MFE: could be links to publically available wikis/documents.
This MFE is bundled with Devstack, see the Getting Started section for setup instructions.
Enumerated list of steps & code blocks, like this:
mkdir -p ~/workspace/ cd ~/workspace/ git clone https://github.com/openedx/devstack.gitInclude as many screenshots as you can, to make your guide easier to follow! Include images with the following syntax:
Does this MFE rely on other MFEs, or LMS/Studio? Does it require use of specific APIs? Do certain settings need to be enabled?
This is optional, but you might have additional sections you wish to cover such as i18n notes, build process notes, stuff about ADRs, stuff about architecture, or more.
- A bulleted list of issues, ideally with JIRA ticket numbers attached
- OR - a link to a publically available wiki/document
The following is a list of current short-term development targets, in (rough) descending order of priority:
- A bulleted list of roadmap items, ideally with JIRA ticket numbers attached (but could just be a high-level overview of upcoming features/epics)
- OR - a link to a publically available wiki/document
References (for authors of the README; delete this section before publishing)
- https://github.com/openedx/frontend-app-library-authoring/blob/master/README.rst has many of the above discussed sections and implements them well
- https://opencraft.com/blog/introducing-open-edx-publisher/#how-does-it-work is an example of explaining when env variables/settings are required