added quickstart

yash980 · Jun 24, 2014 · c187ff2 · c187ff2
1 parent 56c12e5
commit c187ff2
Show file tree

Hide file tree

Showing 5 changed files with 1,699 additions and 1 deletion.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -20,6 +20,7 @@ Contents:
     :maxdepth: 4 
 
     Installation Guide <install>
+    Quickstart <quickstart>
     API <ffn>
 
 Indices and tables

diff --git a/docs/source/install.rst b/docs/source/install.rst
@@ -9,7 +9,7 @@ using ``pip`` or ``easy_insatll``:
 
     $ pip install ffn
 
-If pip is not installed, I recommend installing the `Anaconda Scientific Python
+If pip is not installed, we recommend installing the `Anaconda Scientific Python
 Distribution <https://store.continuum.io/cshop/anaconda/>`_. This distribution comes with many of the required packages pre-installed, including pip. Once Anaconda is installed, the above command should complete the installation. 
 
 ffn should be compatible with Python 2.7. 
diff --git a/docs/source/quickstart.ipynb b/docs/source/quickstart.ipynb
diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst
@@ -0,0 +1,18 @@
+Quickstart
+==========
+
+First things first, we must install ffn. ffn stands on the shoulders of giants
+and therefore has many requirements. The easiest way to get started is to
+install the `Anaconda Scientific Python Distribution <https://store.continuum.io/cshop/anaconda/>`_. 
+This distribution comes with many of the required packages pre-installed, including pip. 
+
+To install ffn, simply run:
+
+.. code-block:: bash
+    
+    $ pip install ffn
+
+Now let's get started. By the way, We are using an IPython Notebook for our example. If you don't know what
+that is, you definitely need to check it out `here <http://ipython.org/notebook.html>`__!
+
+.. notebook:: quickstart.ipynb