Close issue #1

README.md

@@ -45,6 +45,34 @@ install the matching software (`CERMINE`, `Grobid` or `pdf-extract`). See the
 docstrings of those functions for more infos on this particular point.
 
 
+## Installation
+
+Either use `pip install libbmc` or download the ZIP archive from this repo and
+install it manually using `python setup.py install`.
+
+
+## Running unittests
+
+Just run
+```
+nosetests --with-doctest
+```
+
+at the root of the Git repository to run the unittests.
+
+
+## Building the doc
+
+Just run
+
+```
+cd docs
+make html
+```
+
+Documentation will be generated in the `docs/build/html` folder.
+
+
 ## Note on `__valid_identifiers__`
 
 `libbmc` exposes a `__valid_identifiers__` list, containing the valid

docs/source/index.rst

@@ -6,11 +6,25 @@
 Welcome to LibBMC's documentation!
 ==================================
 
+:Author: Phyks (Lucas Verney)
+:Devel: `github.com project <https://github.com/Phyks/libbmc/>`_
+:Mirror: `git.phyks.me <http://git.phyks.me/Phyks/libbmc>`_
+:Bugs: `github.com <https://github.com/Phyks/libbmc/issues>`_
+:Generated: |today|
+:License: MIT
+:Version: |release|
+
+A python library to deal with scientific papers.
+
+
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
+   install.rst
+   libbmc.rst
+
 
 
 Indices and tables
@@ -19,4 +33,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-

docs/source/install.rst

@@ -0,0 +1,63 @@
+========================
+How to install and test?
+========================
+
+How to install?
+===============
+
+Requirements
+------------
+
+* python **3.3** or newer
+* See ``README.md`` for full details on external dependencies.
+
+
+PyPI (recommended)
+---------------------------------
+
+`See Pypi <https://pypi.python.org/pypi/libbmc/>`_
+
+To install with pip:
+
+.. code-block:: sh
+
+    pip install libbmc
+
+
+Manual installation (recommended for packagers)
+-----------------------------------------------
+
+`Download <ihttps://github.com/Phyks/libbmc/archive/master.zip>`_ the archive.
+
+.. code-block:: sh
+
+    python setup.py install
+
+
+How to run the test suite?
+==========================
+
+This page briefly describes how to run the test suite.
+This is useful for contributors, for packagers but also for users who wants to check their environment.
+
+
+Virtualenv
+----------
+
+You can make a virtualenv. I like `pew <https://pypi.python.org/pypi/pew/>`_ for that because the API is easier.
+
+The first time, you need to make a virtualenv
+
+.. code-block:: sh
+
+    pew mkproject libbmc
+    pip install -r requirements.txt
+    python setup.py install
+    nosetest
+
+
+If you already have a virtualenv, you can use workon
+
+.. code-block:: sh
+
+    pew workon libbmc