From e355d926ba45e95eb391c5b18a1f951bdefd49c5 Mon Sep 17 00:00:00 2001 From: Brad Miller Date: Mon, 15 May 2023 15:02:53 -0500 Subject: [PATCH] Update Docs --- README.rst | 4 +++- docker/README.rst | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 87c84645c..e5b710505 100644 --- a/README.rst +++ b/README.rst @@ -13,7 +13,9 @@ Runestone Academy Server and API .. image:: https://readthedocs.org/projects/runestoneserver/badge/?version=latest :target: https://runestoneserver.readthedocs.io/en/latest/?badge=latest - :alt: Documentation Status + :alt: Documentation Status + +**Note:** This repository will be archived very soon. All Runestone Development has moved to the ``RunestoneInteractive/rs`` monorepo. Runestone Server Introduction diff --git a/docker/README.rst b/docker/README.rst index 44db29129..eefa1a80b 100644 --- a/docker/README.rst +++ b/docker/README.rst @@ -258,6 +258,8 @@ The ``rsmanage`` command will run many useful commands inside the container for ...and many other things. Just type ``rsmanage`` for a list of things it can do. For a list of options just type ``rsmanage`` and the subcommand you want followed by ``--help``; for example, ``rsmanage build --help``. +If at this stage you type `rsmanage --help` and you get a command not found it is likely that pip installed the command in a different location than the one in your PATH. It could be in ``~/.local/bin`` or ``/usr/local/bin`` or ``/opt/local/bin``. You can add that location to your PATH or you can just type the full path to the command. For example, ``~/.local/bin/rsmanage`` + 7. Add books ************ @@ -267,7 +269,7 @@ No books are installed by default; you must add books using the following proces .. code-block:: bash - rsmanage build thinkcspy --clone https://github.com/RunestoneInteractive/thinkcspy.git + rsmanage build --clone https://github.com/RunestoneInteractive/thinkcspy.git thinkcspy After cloning a book, you may need to add it to the database. Most of the standard books are already there, but you can use ``rsmanage addcourse`` to add it if needed.