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

Commit 1213f56

Browse files
committed
Update README
1 parent d3dcd84 commit 1213f56

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.rst

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,24 @@ You will now have a build folder with a file index.html in it, along with some d
4747
$ runestone serve
4848

4949

50-
Now from your browser you can open up http://localhost:8000/index.html
50+
Now from your browser you can open up ``http://localhost:8000/index.html`` You should see the table of contents for a sample page. If you edit ``_sources/index.html`` or ``_sources/overview.rst`` and then rebuild and serve again you will see your changes. The best documentation is probably the overview.rst file itself, as it demonstrates how to use all of the common components and shows most of their options.
51+
52+
53+
**Windows Users** I have tested the installation, along with init, build, and serve on Windows 8.1.
54+
The biggest pain is probably setting your PATH environment variable so you can simply type the commands
55+
from the shell. Please note that I am not a regular user of windows, I only test things on my VMWare
56+
installation every so often. If you are new to using Python on windows I recommend you check out this
57+
link on `Using Python with Windows <https://docs.python.org/3.4/using/windows.html>`_
58+
59+
60+
Notes for more Advanced Users
61+
-----------------------------
62+
63+
If you already have an existing `Sphinx <http://sphinx-doc.org>`_ project and you want to incorporate the runestone components into your project you can just make a couple of simple edits to your existing ``conf.py`` file.
64+
65+
* First add the following import line ``from runestone import runestone_static_dirs, runestone_extensions``
66+
* Then modify your extensions. You may have a different set of extensions already enabled, but it doesn't matter just do this: ``extensions = ['sphinx.ext.mathjax'] + runestone_extensions()``
67+
* Then modify your html_static_path: ``html_static_path = ['_static'] + runestone_static_dirs()`` Again you may have your own set of static paths in the initial list.
5168

52-
That is all. For now.
5369

5470
See https://github.com/bnmnetp/runestone/wiki/DevelopmentRoadmap to get a sense for how this is all going to come together.

0 commit comments

Comments
 (0)