docs: include dev instuctions in README

kdmccormick · Apr 6, 2022 · 88a58b3 · 88a58b3
1 parent baf7d03
commit 88a58b3
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -63,10 +63,21 @@ Features
 Quickstart
 ----------
 
+For Open edX deployers
+~~~~~~~~~~~~~~~~~~~~~~
+
 1. Install the `latest stable release <https://github.com/overhangio/tutor/releases>`_ of Tutor
 2. Run ``tutor local quickstart``
 3. You're done!
 
+
+For Open edX develeopers
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+1. Install `Tutor Nightly <docs/tutorials/nightly.rst#install>`_
+2. Run ``tutor dev quickstart``
+3. You're done!
+
 Documentation
 -------------
 

diff --git a/docs/tutorials/nightly.rst b/docs/tutorials/nightly.rst
@@ -5,6 +5,8 @@ Running Open edX on the master branch ("nightly")
 
 Tutor was designed to make it easy for everyone to run the latest release of Open edX. But sometimes, you want to run the latest, bleeding-edge version of Open edX. This is what we call "running master", as opposed to running the release branch. Running the master branch in production is strongly **not** recommended unless you are an Open edX expert and you really know what you are doing. But Open edX developers frequently need to run the master branch locally to implement and test new features. Thus, Tutor makes it easy to run Open edX on the master branch: this is called "Tutor Nightly".
 
+.. _install:
+
 Installing Tutor Nightly
 ------------------------
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,6 +5,8 @@ Running Open edX on the master branch ("nightly") @@
     Tutor was designed to make it easy for everyone to run the latest release of Open edX. But sometimes, you want to run the latest, bleeding-edge version of Open edX. This is what we call "running master", as opposed to running the release branch. Running the master branch in production is strongly **not** recommended unless you are an Open edX expert and you really know what you are doing. But Open edX developers frequently need to run the master branch locally to implement and test new features. Thus, Tutor makes it easy to run Open edX on the master branch: this is called "Tutor Nightly".
+    .. _install:
     Installing Tutor Nightly
     ------------------------
@@ Expand Down @@