diff --git a/README.rst b/README.rst index 3e12a3a..2d21000 100644 --- a/README.rst +++ b/README.rst @@ -1,34 +1,32 @@ -deck plugin for `Tutor `__ -###################################################### +`Tutor `__ Deck +########################################### -Awesome administration dashboard and plugin marketplace for Tutor +This is a plugin for `Tutor`_ that provides an administration dashboard and integrates `Plugin Marketplace`_ in an Open edX platform. + + +.. _Tutor: https://docs.tutor.edly.io +.. _Plugin Marketplace: https://edly.io/tutor/plugins-and-themes/ Installation ************ -.. code-block:: bash + tutor plugins update + tutor plugins install deck + tutor plugins enable deck - pip install git+https://github.com/overhangio/tutor-deck +Run Tutor Deck with:: -.. TODO how to package css files? + tutor deck runserver -Usage -***** - -.. code-block:: bash - - tutor plugins enable deck +And access the interface at http://127.0.0.1:3274 Development *********** -Install locally:: +Install requirements:: pip install -e .[dev] - -Install npm requirements:: - npm clean-install Compile SCSS files:: @@ -40,7 +38,54 @@ Run a development server:: make runserver +Usage +***** + +Discover and install plugins from plugin marketplace: + +.. image:: https://github.com/overhangio/tutor-deck/images/marketplace.png + :alt: Marketplace Image + +Browse your installed plugins: + +.. image:: https://github.com/overhangio/tutor-deck/images/installed.png + :alt: Installed Image + +Enable/Disable plugin: + +.. image:: https://github.com/overhangio/tutor-deck/images/android.png + :alt: Android Image + +Change plugin parameters: + +.. image:: https://github.com/overhangio/tutor-deck/images/android_settings.png + :alt: Android Settings Image + +Use Developer mode for all tutor CLI commands: + +.. image:: https://github.com/overhangio/tutor-deck/images/developer.png + :alt: Developer Image + +Restart platform via GUI to apply changes: + +.. image:: https://github.com/overhangio/tutor-deck/images/apply.png + :alt: Apply Image + +Troubleshooting +*************** + +This Tutor plugin is maintained by Muhammad Labeeb from `Edly`_. +Community support is available from the official `Open edX forum`_. +Do you need help with this plugin? See the `troubleshooting`_ +section from the Tutor documentation. + +.. _Edly: https://edly.io/ +.. _Open edX forum: https://discuss.openedx.org +.. _troubleshooting: https://docs.tutor.edly.io/troubleshooting.html + License ******* -This software is licensed under the terms of the AGPLv3. +This work is licensed under the terms of the `GNU Affero General Public License (AGPL)`_. + +.. _GNU Affero General Public License (AGPL): https://github.com/overhangio/tutor/blob/release/LICENSE.txt diff --git a/images/android.png b/images/android.png new file mode 100644 index 0000000..a06293a Binary files /dev/null and b/images/android.png differ diff --git a/images/android_settings.png b/images/android_settings.png new file mode 100644 index 0000000..75f48dd Binary files /dev/null and b/images/android_settings.png differ diff --git a/images/apply.png b/images/apply.png new file mode 100644 index 0000000..8506b0f Binary files /dev/null and b/images/apply.png differ diff --git a/images/developer.png b/images/developer.png new file mode 100644 index 0000000..ae2eb0c Binary files /dev/null and b/images/developer.png differ diff --git a/images/installed.png b/images/installed.png new file mode 100644 index 0000000..db7a6be Binary files /dev/null and b/images/installed.png differ diff --git a/images/marketplace.png b/images/marketplace.png new file mode 100644 index 0000000..a181f13 Binary files /dev/null and b/images/marketplace.png differ