Skip to content
This repository was archived by the owner on Jun 7, 2023. It is now read-only.

Commit 7102276

Browse files
committed
move README back to rst for compatibility with pypi index.
1 parent 12275fb commit 7102276

File tree

2 files changed

+25
-22
lines changed

2 files changed

+25
-22
lines changed

README.rst

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,54 @@
11
RunestoneComponents
22
===================
33

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.
65
**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.
77

8-
Check out the [Development Roadmap](https://github.com/bnmnetp/runestone/wiki) to get an understanding of our migration towards webcomponents.
98

109
Quick Start
1110
-----------
1211

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
1417

15-
```
16-
pip install runestone
17-
```
1818

1919
Or, if you prefer to live on the development edge, you can check out the very latest from:
2020

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+
2425

2526
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:
2627

27-
```
28-
mkdir myproject
29-
cd myproject
30-
runestone init
31-
```
28+
::
29+
30+
mkdir myproject
31+
cd myproject
32+
runestone init
33+
3234

3335
The init command will ask you some questions and setup a default project for you.
3436

3537
To build the included default project run
3638

37-
```
38-
runestone build
39-
```
39+
::
40+
41+
runestone build
42+
4043
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.
4144

42-
```
45+
::
4346

4447
$ runestone serve
45-
```
48+
4649

4750
Now from your browser you can open up http://localhost:8000/index.html
4851

4952
That is all. For now.
5053

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.

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
# data_files=[('common',['runestone/common/*']),
3737
# ('project/template', ['newproject_copy_me/*'])
3838
# ],
39-
long_description=open('README.md').read(),
39+
long_description=open('README.rst').read(),
4040
entry_points = {
4141
'console_scripts': [
4242
'runestone = runestone.__main__:main'

0 commit comments

Comments
 (0)