Documentation

docs/index.rst

@@ -6,11 +6,29 @@
 Welcome to SlackInvite's documentation!
 =======================================
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+This is a light weight **Django Slack Invite** web application
+designed to automate the invite process for slack teams.
+
+With this code you can quickly deploy a custom slack invite page
+to Heroku for your team.
+
+This application was built using the following technologies and frameworks:
+- Python 3.6
+- Django 1.11
+- HTML5 Boilerplate
+- Twitter Bootstrap
 
+This application was also designed with Test Driven Development in mind
+and utilizes development, testing and production environments.
 
+To start customizing and using the web app, check out the :doc:'requirements'
+followed by the :doc:'quick_start'
+
+.. toctree::
+   :maxdepth: 2
+
+   requirements
+   quick_start
 
 Indices and tables
 ==================

docs/quick_start.rst

@@ -0,0 +1,22 @@
+Quick Start Guide
+=================
+
+Download TaskBuster Django Slack Invite Project
+-----------------------------------------------
+
+First, you need to download the BoilerPlate from GitHub. 
+
+
+Secret Django Key
+-----------------
+
+This application has the **DJANGO_KEY** setting variable hidden. 
+
+You can generate your DJANGO_KEY |django_key|.
+
+.. |django_key| raw:: html
+
+    <a href="http://www.miniwebtool.com/django-secret-key-generator"
+    target="_blank">here</a>
+
+Don't worry, more documentation is coming soon!

docs/requirements.rst

@@ -0,0 +1,32 @@
+Requirements
+============
+
+The requirements necessary to develope custom a Django Slack Invite page are:
+
+- **python3** and **pip3**
+- **virtualenv** and **virtualenvwrapper**
+- **Django**
+- **Firefox** (to use Selenium's Webdriver in functional tests)
+
+If you don't have the first two requirements, you may find these
+installation guides helpful: 
+
+- |python_install_mac|
+- |python_install_linux|
+
+.. |python_install_linux| raw:: html
+
+    <a href="http://python-guide-pt-br.readthedocs.io/en/latest/starting/install3/linux/" target="_blank"> Linux
+
+.. |python_install_mac| raw:: html
+
+    <a href="http://python-guide-pt-br.readthedocs.io/en/latest/starting/install3/osx/" target="_blank">Mac OS X</a>
+
+You can download Firefox from the official web page: |firefox_web|.
+
+.. |firefox_web| raw:: html
+
+     <a href="https://www.mozilla.org" target="_blank">Firefox</a>
+
+
+**Ready!?** Continue to the :doc:`quick_start`!