From: dsc <david.schoonover@gmail.com>
Date: Thu, 16 Dec 2010 00:24:58 +0000 (-0800)
Subject: Adds wiki info page for contributors.
X-Git-Url: http://git.less.ly:3516/?a=commitdiff_plain;h=a853c8092e9f81bf5900e554a6c1ae0da0bb39ef;p=tanks-wiki.git

Adds wiki info page for contributors.
---

diff --git a/wiki/markdoc.md b/wiki/markdoc.md
new file mode 100644
index 0000000..79f61fa
--- /dev/null
+++ b/wiki/markdoc.md
@@ -0,0 +1,51 @@
+# Wiki / Markdoc Links and Info
+
+Information about using this wiki.
+
+[TOC]
+
+
+## Wiki Info
+
+ * The wiki uses [git](http://git-scm.com) for version control, merging, and auth.
+ * [Recent Changes](http://git.lttlst.com/?p=tanks-wiki.git;a=shortlog)
+ * [Changes RSS Feed](http://git.lttlst.com/?p=tanks-wiki.git;a=atom)
+
+
+## Editing this Wiki
+
+ 1. You need [git](http://git-scm.com)!
+ 1. Now clone the wiki repo: `git clone git@lttlst.com:tanks-wiki.git`
+ 1. You'll now have a `tanks-wiki` directory, and in it, a `wiki` directory. That's where all the pages are. They're plaintext files in Markdown format (see below).
+ 1. If you want to test your changes locally, install Markdoc (see below) and 
+ 1. Once you're done editing, commit your changes locally (you'll also have to `git add` any new files): `git commit -a -m "commit message"`
+ 1. Now push your changes to the server: `git push origin master`
+ 1. There is a hook which automatically updates and rebuilds the wiki when this occurs.
+ 1. Refresh [http://wiki.lttlst.com](http://wiki.lttlst.com) to see your changes!
+
+
+## Markdoc
+
+Markdoc is a lightweight Markdown-based wiki system. It’s been designed to allow you to create and manage wikis as quickly and easily as possible.
+
+ * Project Home: [http://markdoc.org](http://markdoc.org)
+ * Source: [https://github.com/zacharyvoase/markdoc](https://github.com/zacharyvoase/markdoc)
+ * Running it locally:
+    - You'll need [Python](http://python.org) 2.5+ and [setuptools](http://pypi.python.org/pypi/setuptools/). Install instructions can be found on those pages.
+    - Setuptools gives you the `easy_install` command for installing Python packages off PyPi. Do so for Markdoc: `easy_install markdoc`
+    - To build the wiki, run `markdoc build` at the wiki root.
+    - To set up an ad-hoc webserver to view your changes, run `markdoc serve` -- it'll tell you what port it's running on (probably `8008`).
+
+
+## Markdown
+
+Markdown is the wiki syntax of Markdoc (and its namesake project). I adore Markdown; it's a great example of an elegant solution to a super-common problem: I want to write plaintext and get html documents. I don't want fancy bullshit or tons of syntax.
+
+ * Project Home: [http://daringfireball.net/projects/markdown](http://daringfireball.net/projects/markdown)
+ * Syntax: [http://daringfireball.net/projects/markdown/syntax](http://daringfireball.net/projects/markdown/syntax)
+ * On embedding source-code: [http://markdoc.org/tips/syntax-highlighting](http://markdoc.org/tips/syntax-highlighting)
+ * Extension Docs: [http://www.freewisdom.org/projects/python-markdown/Available_Extensions](http://www.freewisdom.org/projects/python-markdown/Available_Extensions)
+ * Python Markdown package: [http://www.freewisdom.org/projects/python-markdown](http://www.freewisdom.org/projects/python-markdown)
+
+A good example of Markdown in action is, in fact, the [Markdown syntax page source](http://daringfireball.net/projects/markdown/syntax.text).
+