added notes for building and releasing

spencergibb · Feb 4, 2014 · 14e083c · 14e083c
1 parent f640199
commit 14e083c
Showing 1 changed file with 29 additions and 0 deletions.
diff --git a/BUILDING.md b/BUILDING.md
@@ -0,0 +1,29 @@
+### Building locally
+
+    git checkout devel
+
+    # make changes
+
+    git commit
+
+    git push
+
+    git checkout master
+
+    make sdist
+
+    git checkout devel #make sure to go back to devel to make changes
+
+### deploying to pypi
+
+make sure `~/.pypirc` is setup correctly
+
+    [pypirc]
+    servers = pypi
+    [server-login]
+    username:<username>
+    password:<password>
+
+then
+
+    python setup.py sdist upload