You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 7, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: README.rst
+12-32Lines changed: 12 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,51 +21,31 @@ Runestone Version 6
21
21
Documentation
22
22
-------------
23
23
24
-
You will find the new `Authors Guide <https://runestone.academy/runestone/static/authorguide/index.html>`_
24
+
Writing **new** books using the Runestone RST markup language is deprecated as of Summer 2022. It is strongly recommended that you use the `PreTeXt <https://pretextbook.org>`_ markup language for writing new books.
25
25
26
-
If you want to report any issues with the docs or submit PRs to improve them please do so on `github <https://github.com/RunestoneInteractive/runestoneinteractive.github.io/issues>`_
26
+
* Take a look at the `Sample Book <https://pretextbook.org/examples/sample-book/annotated/sample-book.html>` Especially Chapter 3, the section titled Interactive Exercises. The activecode, CodeLens and all the rest of the interactives that you see in that sample book are powered by the components in this repository. This repository will remain the home of those interctive components.
27
27
28
-
Make sure you are using Python 3.7 or later.
28
+
* Take a look at the `PreTeXt Guide <https://pretextbook.org/doc/guide/html/guide-toc.html>`_ It contains comprehensive documentation on writing in PreTeXt.
29
29
30
-
I made a video that shows how to `install the Runestone Components <https://youtu.be/Fy0S4bGRPNE>`_ into a nice clean environment.
30
+
* As an Author you will want to use the PreTeXt CLI for writing books. Experienced Runestone authors will find the pretext cli to be quite familiar, but better organized with fewer mysterious configuration files. See `PreTeXt-CLI <https://pretextbook.org/doc/guide/html/guide-toc.html>`
31
31
32
32
33
33
Quick Start
34
34
-----------
35
35
36
-
If you are completely new to pip and github text editors, I have written a more thorough getting started
37
-
tutorial `on my blog <http://reputablejournal.com/how-to-make-a-lab-in-three-easy-steps.html>`_
38
-
Otherwise, you can install everything you need with one simple command! (Although I recommend that you first create a virtual environment for your work.)
* Video here: https://www.youtube.com/watch?v=IX-v6yvGYFg
44
-
* For the impatient:
41
+
Old Documentation
42
+
-----------------
45
43
46
-
::
47
-
48
-
$ sudo pip install virtualenv
49
-
$ virtualenv /path/to/home/MyEnv
50
-
$ source /path/to/home/MyEnv/bin/activate
51
-
52
-
* You will need to do the last command **every time** you want to work on RunestoneComponents. If you have not used Python virtual environments before I strongly recommend reading the docs or watching the video
53
-
54
-
* *Note:* You might need to install ``pip`` based on how you have installed `python <https://packaging.python.org/tutorials/installing-packages/#ensure-you-can-run-pip-from-the-command-line>`_.
55
-
56
-
With the virtual environment installed and configured you can continue.
57
-
::
58
-
59
-
pip install runestone
60
-
61
-
62
-
63
-
Or, if you prefer to live on the development edge, you can check out the very latest from:
64
-
65
-
::
44
+
I will keep this around for a while during the transition to PreTeXt.
0 commit comments