Add some minimal documentation

Signed-off-by: Steven Esser <sesser@nexb.com>
aboutcode-org · Sep 25, 2020 · 565feee · 565feee
1 parent 9a56b88
commit 565feee
Showing 1 changed file with 29 additions and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -1,3 +1,31 @@
 A Simple Python Project Skeleton
 ================================
-Note: configure script requires src/ directory to run correctly.
+This repo attempts to standardize our python repositories using modern python
+packaging and configuration techniques. Using this `blog post`_ as inspiration, this
+repository will serve as the base for all new python projects and will be adopted to all 
+our existing ones as well.
+
+.. _blog post: https://blog.jaraco.com/a-project-skeleton-for-python-projects/
+
+Usage
+=====
+A brand new project
+-------------------
+.. code-block:: bash
+
+    git init my-new-repo
+    cd my-new-repo
+    git pull git@github.com:nexB/skeleton
+
+From here, you can make the appropriate changes to the files for your specific project.
+
+Update an existing project
+---------------------------
+.. code-block:: bash
+
+    cd my-existing-project
+    git remote add skeleton git@github.com:nexB/skeleton
+    git fetch skeleton
+    git merge skeleton --allow-unrelated-histories
+
+This is also the workflow to use when updating the skeleton files in any given repository.