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

Commit 6dfe65c

Browse files
authored
Merge pull request #932 from alexmojaki/clarify-serve
Clarify difference between RunestoneServer and `runestone serve`
2 parents 2a92fb2 + d1f8841 commit 6dfe65c

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

README.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,15 +77,12 @@ To build the included default project run
7777

7878
runestone build
7979

80-
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.
81-
8280
*Note:* If you come across version conflict with ``six`` library while building the project, ``pip install --ignore-installed six`` command might be useful.
8381

84-
::
82+
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 provided Python webserver::
8583

8684
$ runestone serve
8785

88-
8986
Now from your browser you can open up ``http://localhost:8000/index.html`` You should see the table of contents for a sample page like this:
9087

9188
.. image:: images/runeCompo-index.png

runestone/__main__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,9 @@ def build(all, wd):
126126
@click.option('--port', default=8000, help="port for server to listen on")
127127
@click.option('--listen', default="", help="address for server to listen on")
128128
def serve(port,listen):
129+
click.echo("Note: this is a minimal static server without templates or a database.")
130+
click.echo("For many use cases this is fine.")
131+
click.echo("For the full server, see https://github.com/RunestoneInteractive/RunestoneServer")
129132
os.chdir(findProjectRoot())
130133
sys.path.insert(0,os.getcwd())
131134
try:

0 commit comments

Comments
 (0)