Daniel Gonçalves committed 91098f0

Added a hint to call configure() and installation tips.

  • Participants
  • Parent commits 315298f

Comments (0)

Files changed (1)

File doc/source/index.rst

    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 Welcome to ConfigViper
 .. code-block:: python
     from configviper import ConfigViper
+    ConfigViper.configure()
     conf = ConfigViper()
     conf.set('a/b/c', 'd')
-And the JSON file will looks like:
+And the JSON file will looks like (``~/.configviper/configviper.json``):
 .. code-block:: json
 #. Small and simple to be written by me (so anyone can use/contribute and/or
    point my faults).
+Install ConfigViper using ``pip install ConfigViper`` command. If you downloaded
+the sources from `PyPI`_ go to ``ConfigViper-<version>`` directory and type
+``python install`` command. You can also get the sources from
+`BitBucket`_ repository (you will need `Mercurial SCM`_ installed on your
+    hg clone
 Indices and tables
 .. _`Python`:
 .. _`JSON`:
+.. _`PyPI`:
+.. _`BitBucket`:
+.. _`Mercurial SCM`: