@@ -10,19 +10,29 @@ updated templates, new JavaScript sources, and UI based on FomanticUI
1010in the existing application templates. It is an addition to the
1111``readthedocsext `` package, and provides the ``theme `` Django application.
1212
13- Documentation can be found here: https://read-the-docs-ext-theme.readthedocs-hosted.com/en/latest/index.html
14-
15- JavaScript help can be found here: https://github.com/readthedocs/meta/discussions/114
16-
1713.. warning ::
1814 This package is still alpha level quality and is not ready for general use.
1915
16+ Installation
17+ ------------
18+
19+ If you built your local development image with a GitHub token defined, this
20+ package is already installed in your built image. This should be the default for
21+ core team.
22+
23+ If not, follow the application `installation directions <https://dev.readthedocs.io/en/latest/install.html >`__
24+ again, and make sure to set the neccessary GitHub token environment variables.
25+
26+ You will want to check this repository out in the same path as your other
27+ repositories if you plan on doing development on the files in this repository:
28+
29+ .. code :: console
30+
31+ % git clone --recurse-submodules [email protected] :readthedocs/ext-theme.git 32+
2033 Usage
2134-----
2235
23- This package is already installed with your local environment, which will need
24- to be configured to use this package.
25-
2636The recommended way of starting your local instance is:
2737
2838.. code :: console
@@ -86,3 +96,6 @@ More resources
8696
8797`Template API reference <https://docs.ops.verbthenouns.com/projects/ext-theme/en/latest/api/templates.html >`_
8898 Template reference and documentation
99+
100+ `Learning JavaScript <https://github.com/readthedocs/meta/discussions/114 >`_
101+ Some resources on learning modern JavaScript
0 commit comments