Permalink
Browse files

add readme

  • Loading branch information...
1 parent d5b4fa5 commit b123a044e62380ef588b50b9c052896d86c75a85 @paularmstrong committed Nov 6, 2012
Showing with 34 additions and 1 deletion.
  1. +1 −1 Makefile
  2. +33 −0 README.md
View
@@ -30,4 +30,4 @@ lint:
test:
@echo ''
-.PHONY: all, test, line
+.PHONY: all, clean, build, lint, test
View
@@ -0,0 +1,33 @@
+Swig Website
+============
+
+Use Swig to build the Website for Swig and publish to GitHub pages. Uses [still](https://github.com/paularmstrong/still).
+
+Getting Started
+---------------
+
+Install dependencies
+
+```
+make
+```
+
+Editing & Testing
+-----------------
+
+Start the server
+
+```
+make run
+```
+
+Edit and reload pages at will.
+
+Publishing
+----------
+
+Publish to gh-pages. Requires swig main repo push access.
+
+```
+make build
+```

0 comments on commit b123a04

Please sign in to comment.