neale/moth
neale
/
moth
mirror of https://github.com/dirtbags/moth.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README to emphasize devel server

This commit is contained in:
Neale Pickett 2018-05-17 13:42:09 +00:00
parent 6532ae343a
commit 2fb252b9b2
1 changed files with 11 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -18,6 +18,15 @@ It also tracks scores,
and comes with a JavaScript-based scoreboard to display team rankings.
Getting Started Developing
-------------------------------
You'll want to start out with the Development Server.
More on how the devel sever works in
[the devel server documentation](docs/devel-server.md)
How everything works
---------------------------
@ -26,29 +35,11 @@ Please check out [the overview](docs/overview.md)
for details.
Getting Started Developing
-------------------------------
If you don't have a `puzzles` directory,
you can copy the example puzzles as a starting point:
$ cp -r example-puzzles puzzles
Then launch the development server:
$ python3 tools/devel-server.py
Point a web browser at http://localhost:8080/
and start hacking on things in your `puzzles` directory.
More on how the devel sever works in
[the devel server documentation](docs/devel-server.md)
Running A Production Server
====================
XXX: Update this
Please submit a merge request to improve this section ;)
How to install it
--------------------