From 063ec80cdef57018885366ff28c3c3147ec9d453 Mon Sep 17 00:00:00 2001 From: sarina Date: Fri, 21 Mar 2025 14:42:18 -0400 Subject: [PATCH] docs: Add instructions on using Tutor for development --- README.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 01b85c38..474657e2 100644 --- a/README.rst +++ b/README.rst @@ -29,7 +29,13 @@ Getting Started Installation ============ -This MFE is bundled with `Devstack `_, see the `Getting Started `_ section for setup instructions. +`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 +================================== 1. Install Devstack using the `Getting Started `_ instructions.