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

Commit

Permalink
move README back to rst for compatibility with pypi index.
Browse files Browse the repository at this point in the history
  • Loading branch information
bnmnetp committed May 9, 2015
1 parent 12275fb commit 7102276
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 22 deletions.
45 changes: 24 additions & 21 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,51 +1,54 @@
RunestoneComponents
===================

Packaging of the Runestone components for publishing educational materials using Sphinx and restructured text.

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.
**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.
Check out the `Development Roadmap <https://github.com/bnmnetp/runestone/wiki>`_ to get an understanding of our migration towards webcomponents.

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

Quick Start
-----------

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.
You can install everything you need with one simple command! (Although I recommend that you first create a virtual environment for your work.)

::

pip install runestone

```
pip install runestone
```

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

```
pip install git+git://github.com/RunestoneInteractive/RunestoneTools.git
```
::

pip install git+git://github.com/RunestoneInteractive/RunestoneTools.git


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:

```
mkdir myproject
cd myproject
runestone init
```
::

mkdir myproject
cd myproject
runestone init


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

To build the included default project run

```
runestone build
```
::

runestone build

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.

```
::

$ runestone serve
```


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

That is all. For now.

See https://github.com/bnmnetp/runestone/wiki/DevelopmentRoadmap to get a sense for how this is all going to come together.
See https://github.com/bnmnetp/runestone/wiki/DevelopmentRoadmap to get a sense for how this is all going to come together.
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
# data_files=[('common',['runestone/common/*']),
# ('project/template', ['newproject_copy_me/*'])
# ],
long_description=open('README.md').read(),
long_description=open('README.rst').read(),
entry_points = {
'console_scripts': [
'runestone = runestone.__main__:main'
Expand Down

0 comments on commit 7102276

Please sign in to comment.