Skip to content

docs: Update README to use Tutor #453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arbrandes merged 1 commit into from
Mar 25, 2025
Merged

docs: Update README to use Tutor #453

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,25 @@ frontend-app-support-tools
Purpose
*******

This repository contains a series of support tools for the OpenedX platform.
This repository contains a series of support tools for the Open edX platform.

***************
Getting Started
***************

Prerequisite
=============
Developing with Tutor
=====================

`Tutor`_ is currently recommended as a development environment for your new MFE. Please refer to the `relevant tutor-mfe documentation`_ to get started using it.

.. _Tutor: https://github.com/overhangio/tutor
.. _relevant tutor-mfe documentation: https://github.com/overhangio/tutor-mfe?tab=readme-ov-file#mfe-development

Devstack (Deprecated) instructions
==================================

`Devstack <https://github.com/openedx-unsupported/devstack>`_ is no longer a supported development environment.

`Devstack <https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/index.html>`_.
If you start Devstack with ``make dev.up`` that should give you everything you need as a companion to this frontend.

========================
Expand Down