Skip to content

Commit

Permalink
Making progress on the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dlareau committed Aug 22, 2015
1 parent 3035687 commit 7331c27
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 25 deletions.
55 changes: 30 additions & 25 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,9 @@
contain the root `toctree` directive.
Welcome to PuzzlehuntCMU's Server documentation!
=============================================

A Server for Puzzlehunt CMU's bi-annual puzzlehunt. Includes basic features such as per-puzzle pages, automatic answer response, team logins, customizable unlocking structure, and admin pages to manange submissions, teams, as well as hunt progress. It also includes automatic team creation from registration, privacy settings for hunts, cool charts, a chat with the staff feature, and automatic file fetching and hosting.

Contents:

.. toctree::
:maxdepth: 2
==================================================

A Server for Puzzlehunt CMU's bi-annual puzzlehunt.

Features
--------
Expand All @@ -32,28 +26,39 @@ Installation
------------

You need the following packages for installation, more info to come soon:

System packages:
* python 2.7
* mysql-client
* mysql-server
* python-mysqldb
* redis-server
* python-dev
* imagemagick
* libmysqlclient-dev

Python packages (pip)
* django
* django-websocket-redis
* MySQL-python
* python-dateutil
* django-redis-sessions

- python 2.7
- mysql-client
- mysql-server
- python-mysqldb
- redis-server
- python-dev
- imagemagick
- libmysqlclient-dev

Python packages (pip):

- django
- django-websocket-redis
- MySQL-python
- python-dateutil
- django-redis-sessions

Contents
--------

.. toctree::
:maxdepth: 2

setup

Contribute
----------

- Issue Tracker: github.com/flybye22/puzzlehunt_server/issues
- Source Code: github.com/flybye22/puzzlehunt_server
- Issue Tracker: http://www.github.com/flybye22/puzzlehunt_server/issues
- Source Code: http://www.github.com/flybye22/puzzlehunt_server

Support
-------
Expand Down
4 changes: 4 additions & 0 deletions docs/setup.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Setup
*********

This is a test

0 comments on commit 7331c27

Please sign in to comment.