customized documentation layout

luojiebin · Aug 22, 2014 · 5303f8b · 5303f8b
1 parent cdbe450
commit 5303f8b
Show file tree

Hide file tree

Showing 13 changed files with 25 additions and 621 deletions.
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ Creating Your Project
 
 To create a new Django project, run the following command replacing `{{ project_name }}` with your actual project name:
 
-    $ django-admin.py startproject --template=https://github.com/imkevinxu/django-twoscoops-project/archive/master.zip --extension=py,md,bat,html --name=Procfile,Makefile {{ project_name }}
+    $ django-admin.py startproject --template=https://github.com/imkevinxu/django-twoscoops-project/archive/master.zip --extension=py,md,html --name=Procfile,Makefile {{ project_name }}
 
 Make virtual environments
 -------------------------

diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,17 @@
+Welcome to {{ project_name }}'s documentation!
+==============================================
+
+[Installation](installation.md)
+-------------------------------
+
+Instructions to get your development environment set up and to start coding!
+
+[Deployment](deployment.md)
+---------------------------
+
+Instructions to deploy to production.
+
+[Architecture](architecture)
+----------------------------
+
+High-level overview of how this app is structured and what tools it uses to do what.
diff --git a/docs/__init__.py b/docs/__init__.py
diff --git a/docs/architecture.md b/docs/architecture.md
@@ -0,0 +1,2 @@
+Architecture
+============