saw_021817_2 - Updates to README and .gitignore.

DummyScript · Feb 18, 2017 · 29539a9 · 29539a9
1 parent fc4a34a
commit 29539a9
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 *.swp
 
+build/
 dist/
 
 pyproject.egg-info/

diff --git a/CHANGELOG b/CHANGELOG
@@ -1,5 +1,7 @@
 Copyright (C) 2017 Alpha Griffin
 @%@~LICENSE~@%@
 
+saw_021817_2 - Updates to README and .gitignore.
+
 saw_021817_1 - Initial commit.
 
diff --git a/README.rst b/README.rst
@@ -1,8 +1,28 @@
 
+====================================
 Alpha Griffin Python Starter Project
 ====================================
 
 Starting point for a Python project.
 
-Clone/fork this to stay current with updates to the main build/install script (setup.py).
+
+Starting a Project
+------------------
+
+You can use this repository as a starting point for any Alpha Griffin Python project. Here's an example of one way to accomplish this with GitHub:
+
+1. Start a new repository on GitHub but **do not initialize** as you will be pushing an existing repository (a clone of pyproject). For this example we'll name it *my_new_thing*.
+2. ``git clone http://github.com/AlphaGriffin/pyproject my_new_thing``
+3. ``cd my_new_thing``
+4. ``git remote remove origin``
+5. ``git remote add origin http://github.com/AlphaGriffin/my_new_thing``
+6. ``git push -u origin master``
+
+Now your clone of pyproject lives at the new GitHub address and pushes will go there by default.
+
+
+Installing
+----------
+
+To install this project to the local system: ``python setup.py install``
-Original file line number
+Diff line change
@@ -1,5 +1,6 @@
     *.swp
+    build/
     dist/
     pyproject.egg-info/
@@ Expand Down @@