From 8ae90001319b252b8307354b2904e5e0e8783e20 Mon Sep 17 00:00:00 2001 From: Neale Pickett Date: Fri, 21 Oct 2016 20:38:19 +0000 Subject: [PATCH] Github wants docs/, not doc/ --- README.md | 10 +++++++--- {doc => docs}/CREDITS.md | 0 {doc => docs}/LICENSE.md | 0 {doc => docs}/devel-server.md | 0 {doc => docs}/dirtbags.svg | 0 {doc => docs}/overview.md | 0 {doc => docs}/tokens.md | 0 {doc => docs}/writing-puzzles.md | 0 tools/devel-server.py | 4 ++-- 9 files changed, 9 insertions(+), 5 deletions(-) rename {doc => docs}/CREDITS.md (100%) rename {doc => docs}/LICENSE.md (100%) rename {doc => docs}/devel-server.md (100%) rename {doc => docs}/dirtbags.svg (100%) rename {doc => docs}/overview.md (100%) rename {doc => docs}/tokens.md (100%) rename {doc => docs}/writing-puzzles.md (100%) diff --git a/README.md b/README.md index 766f78c..c167201 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,14 @@ which in the past has been called "Project 2", "HACK", "Queen Of The Hill", -and "Cyber FIRE". +"Cyber Spark", +and "Cyber Fire". Information about these events is at http://dirtbags.net/contest/ This software serves up puzzles in a manner similar to Jeopardy. -It also track scores, +It also tracks scores, and comes with a JavaScript-based scoreboard to display team rankings. @@ -21,7 +22,7 @@ How everything works --------------------------- This section wound up being pretty long. -Please check out [the overview](doc/overview.md) +Please check out [the overview](docs/overview.md) for details. @@ -34,6 +35,9 @@ Getting Started Developing Then 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 ==================== diff --git a/doc/CREDITS.md b/docs/CREDITS.md similarity index 100% rename from doc/CREDITS.md rename to docs/CREDITS.md diff --git a/doc/LICENSE.md b/docs/LICENSE.md similarity index 100% rename from doc/LICENSE.md rename to docs/LICENSE.md diff --git a/doc/devel-server.md b/docs/devel-server.md similarity index 100% rename from doc/devel-server.md rename to docs/devel-server.md diff --git a/doc/dirtbags.svg b/docs/dirtbags.svg similarity index 100% rename from doc/dirtbags.svg rename to docs/dirtbags.svg diff --git a/doc/overview.md b/docs/overview.md similarity index 100% rename from doc/overview.md rename to docs/overview.md diff --git a/doc/tokens.md b/docs/tokens.md similarity index 100% rename from doc/tokens.md rename to docs/tokens.md diff --git a/doc/writing-puzzles.md b/docs/writing-puzzles.md similarity index 100% rename from doc/writing-puzzles.md rename to docs/writing-puzzles.md diff --git a/tools/devel-server.py b/tools/devel-server.py index 8befebc..7fd8f33 100755 --- a/tools/devel-server.py +++ b/tools/devel-server.py @@ -90,8 +90,8 @@ There's stuff you can do here: * [Available puzzles](/puzzles) * [Raw filesystem view](/files/) -* [Documentation](/files/doc/) -* [Instructions](/files/doc/devel-server.md) for using this server +* [Documentation](/files/docs/) +* [Instructions](/files/docs/devel-server.md) for using this server If you use this development server to run a contest, you are a fool.