|
1 | 1 | RunestoneComponents |
2 | 2 | =================== |
3 | 3 |
|
4 | | -Packaging of the Runestone components for publishing educational materials using Sphinx and restructured text. |
5 | | - |
| 4 | +Packaging of the Runestone components for publishing educational materials using Sphinx and restructuredText. Check out the `Overview <http://interactivepython.org/runestone/static/overview/overview.html>`_ To see all of the extensions in action. |
6 | 5 | **NOTE** -- If you have used an older version of this repo, please know this is a total restart. I think much better, and it WILL stay up to date as this is now the master copy of the components not just a copy. |
| 6 | +Check out the `Development Roadmap <https://github.com/bnmnetp/runestone/wiki>`_ to get an understanding of our migration towards webcomponents. |
7 | 7 |
|
8 | | -Check out the [Development Roadmap](https://github.com/bnmnetp/runestone/wiki) to get an understanding of our migration towards webcomponents. |
9 | 8 |
|
10 | 9 | Quick Start |
11 | 10 | ----------- |
12 | 11 |
|
13 | | -Until I get this tested well enough to push onto ``pypi.python.org`` You can install everything you need with one simple command! (Although I recommend that you first create a virtual environment for your work.) Python 2.7.x is required, I have not yet made the directives Python3 compatible. Working on it. |
| 12 | +You can install everything you need with one simple command! (Although I recommend that you first create a virtual environment for your work.) |
| 13 | + |
| 14 | +:: |
| 15 | + |
| 16 | + pip install runestone |
14 | 17 |
|
15 | | -``` |
16 | | -pip install runestone |
17 | | -``` |
18 | 18 |
|
19 | 19 | Or, if you prefer to live on the development edge, you can check out the very latest from: |
20 | 20 |
|
21 | | -``` |
22 | | -pip install git+git://github.com/RunestoneInteractive/RunestoneTools.git |
23 | | -``` |
| 21 | +:: |
| 22 | + |
| 23 | + pip install git+git://github.com/RunestoneInteractive/RunestoneTools.git |
| 24 | + |
24 | 25 |
|
25 | 26 | To start a project, create a new folder and then run the following command (installed by pip) in that new folder ``runestone init`` For example: |
26 | 27 |
|
27 | | -``` |
28 | | -mkdir myproject |
29 | | -cd myproject |
30 | | -runestone init |
31 | | -``` |
| 28 | +:: |
| 29 | + |
| 30 | + mkdir myproject |
| 31 | + cd myproject |
| 32 | + runestone init |
| 33 | + |
32 | 34 |
|
33 | 35 | The init command will ask you some questions and setup a default project for you. |
34 | 36 |
|
35 | 37 | To build the included default project run |
36 | 38 |
|
37 | | -``` |
38 | | -runestone build |
39 | | -``` |
| 39 | +:: |
| 40 | + |
| 41 | + runestone build |
| 42 | + |
40 | 43 | You will now have a build folder with a file index.html in it, along with some default content. The contents of the build folder are suitable for hosting anywhere that you can serve static web content from! For a small class you could even serve the content using the builtin Python webserver. |
41 | 44 |
|
42 | | -``` |
| 45 | +:: |
43 | 46 |
|
44 | 47 | $ runestone serve |
45 | | -``` |
| 48 | + |
46 | 49 |
|
47 | 50 | Now from your browser you can open up http://localhost:8000/index.html |
48 | 51 |
|
49 | 52 | That is all. For now. |
50 | 53 |
|
51 | | -See https://github.com/bnmnetp/runestone/wiki/DevelopmentRoadmap to get a sense for how this is all going to come together. |
| 54 | +See https://github.com/bnmnetp/runestone/wiki/DevelopmentRoadmap to get a sense for how this is all going to come together. |
0 commit comments