Merge pull request #157 from quantopian/install-instructions

DOC: Add install steps

Author: gerrymanoim

README.rst

@@ -7,7 +7,53 @@
 
 Utilities for writing C++ extension modules for CPython.
 
-tests
+Requirements
+------------
+
+lipy supports:
+
+- macOS/Linux
+- Python >=3.5
+
+lipy requires:
+
+- gcc>=8 or clang>=10
+- numpy>=1.11.3
+
+libpy also depends on:
+
+- pcre
+- google sparsehash
+
+To install these dependencies:
+
+ubuntu
+~~~~~~
+
+.. code-block:: bash
+
+    $ sudo apt install libpcre2-dev libsparsehash-dev
+
+macOS
+~~~~~
+
+.. code-block:: bash
+
+    $ brew install pcre2 google-sparsehash
+
+Install
+-------
+
+To install for development:
+
+.. code-block:: bash
+
+   $ make
+
+Otherwise, ``pip install libpy``, making sure ``CC`` and ``CXX`` environment variables are set to the the right compiler.
+
+
+Tests
 -----
 
 To run the unit tests, invoke:

docs/source/index.rst

@@ -6,6 +6,7 @@ Welcome to libpy's documentation!
    :caption: Contents:
 
    tutorial
+   install
    appendix
 
 

docs/source/install.rst

@@ -0,0 +1,57 @@
+Setup
+=====
+
+Requirements
+------------
+
+lipy supports:
+
+- macOS/Linux
+- Python >=3.5
+
+lipy requires:
+
+- gcc>=8 or clang>=10
+- numpy>=1.11.3
+
+libpy also depends on:
+
+- pcre
+- google sparsehash
+
+To install these dependencies:
+
+ubuntu
+~~~~~~
+
+.. code-block:: bash
+
+    $ sudo apt install libpcre2-dev libsparsehash-dev
+
+macOS
+~~~~~
+
+.. code-block:: bash
+
+    $ brew install pcre2 google-sparsehash
+
+Install
+-------
+
+To install for development:
+
+.. code-block:: bash
+
+   $ make
+
+Otherwise, ``pip install libpy``, making sure ``CC`` and ``CXX`` environment variables are set to the the right compiler.
+
+
+Tests
+-----
+
+To run the unit tests, invoke:
+
+.. code-block:: bash
+
+   $ make test