Add Getting Started and update README

README.md

@@ -33,47 +33,9 @@ to submit your contributions as a pull request._
 
 ## Installation
 
-### Dependencies
-
-We use a few applications that you'll need to install and be sure are on your
-PATH.
-
-For OS X using [homebrew](https://brew.sh):
-
-```bash
-brew install poppler
-brew install postgresql
-```
-
-On Debian-based distros:
-
-```bash
-sudo apt-get install poppler-utils
-sudo apt-get install postgresql
-```
-
-For the Python dependencies, we recommend using a
-[virtualenv](https://virtualenv.pypa.io/en/stable/). Once you have cloned the
-repository, change directories to the root of the repository and run
-
-```bash
-virtualenv -p python3 .venv
-```
-
-Once the virtual environment is created, activate it by running
-
-```bash
-source .venv/bin/activate
-```
-
-Any Python libraries installed will now be contained within this virtual
-environment. To deactivate the environment, simply run `deactivate`.
-
-Then, install `Fonduer` by running
-
-```bash
-pip install fonduer
-```
+Check out our [Getting Started
+Guide](https://fonduer.readthedocs.io/en/latest/user/getting_started.html) to
+get up and running.
 
 ## Learning how to use `Fonduer`
 

docs/index.rst

@@ -18,20 +18,21 @@ submit your contributions as a pull request.
 .. _Issues: https://github.com/hazyresearch/fonduer/issues
 
 .. toctree::
-   :maxdepth: 2
-   :caption: User Documentation
-
-   user/lf_helpers
-   user/faqs
+    :maxdepth: 2
+    :caption: User Documentation
+
+    user/getting_started
+    user/lf_helpers
+    user/faqs
 
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Developer Documentation
-
-   dev/changelog
-   dev/install
-   dev/tests
+    :maxdepth: 2
+    :caption: Developer Documentation
+    
+    dev/changelog
+    dev/install
+    dev/tests
 
 
 Acknowledgements

docs/user/getting_started.rst

@@ -0,0 +1,65 @@
+Getting Started
+===============
+
+This document will show you how to get up and running with Fonduer. We'll show
+you how to get everything installed and your machine so that you can walk
+through real examples by checking out our Tutorials_.
+
+Installing External Dependencies
+--------------------------------
+
+Fonduer relies on a couple of external applications. You'll need to install
+these and be sure are on your ``PATH``.
+
+For OS X using homebrew_::
+
+    $ brew install poppler
+    $ brew install postgresql
+
+On Debian-based distros::
+
+    $ sudo apt update
+    $ sudo apt install poppler-utils
+    $ sudo apt install postgresql
+
+.. note::
+    Fonduer requires PostgreSQL version 9.6 or above.     
+
+.. note::
+    Fonduer requires ``poppler-utils`` to be version 0.36.0 or above.
+    Otherwise, the ``-bbox-layout`` option is not available for ``pdftotext``
+    (`see changelog`_).
+
+
+Installing the Fonduer Package
+------------------------------
+
+Then, install Fonduer by running::
+
+    $ pip install fonduer
+
+.. note::
+    Fonduer only supports Python 3. Python 2 is not supported.
+
+.. tip::
+  For the Python dependencies, we recommend using a virtualenv_, which will
+  allow you to install Fonduer and it's python dependencies in a isolated
+  Python environment. Once you have virtualenv installed, you can create a
+  Python 3 virtual environment as follows.::
+
+      $ virtualenv -p python3 .venv
+
+  Once the virtual environment is created, activate it by running::
+
+      $ source .venv/bin/activate
+
+  Any Python libraries installed will now be contained within this virtual
+  environment. To deactivate the environment, simply run::
+    
+      $ deactivate
+
+
+.. _Tutorials: https://github.com/HazyResearch/fonduer-tutorials
+.. _homebrew: https://brew.sh
+.. _virtualenv: https://virtualenv.pypa.io/en/stable/
+.. _see changelog: https://poppler.freedesktop.org/releases.html