diff --git a/readme.rst b/readme.rst index 2eca351da1af4fd2917e2e98643fbe9a10597368..7fc1652d4619927b508a6c23d311a7268fce4755 100644 --- a/readme.rst +++ b/readme.rst @@ -12,27 +12,27 @@ You would normally not install this package unless you are maintaining it. What you would do instead is to tie it in at the package you need to **use** it. There are a few ways to achieve this: - 1. You can add this package as a requirement at the ``setup.py`` for your own - `satellite package - <https://github.com/idiap/bob/wiki/Virtual-Work-Environments-with-Buildout>`_ - or to your Buildout ``.cfg`` file, if you prefer it that way. With this - method, this package gets automatically downloaded and installed on your - working environment, or +1. You can add this package as a requirement at the ``setup.py`` for your own + `satellite package + <https://github.com/idiap/bob/wiki/Virtual-Work-Environments-with-Buildout>`_ + or to your Buildout ``.cfg`` file, if you prefer it that way. With this + method, this package gets automatically downloaded and installed on your + working environment, or - 2. You can manually download and install this package using commands like - ``easy_install`` or ``pip``. +2. You can manually download and install this package using commands like + ``easy_install`` or ``pip``. The package is available in two different distribution formats: - a. You can download it from `PyPI <http://pypi.python.org/pypi>`_, or +1. You can download it from `PyPI <http://pypi.python.org/pypi>`_, or - b. You can download it in its source form from `its git repository - <http://github.com/bioidiap/bob.db.replay.git>`_. When you download the - version at the git repository, you will need to run a command to recreate the - backend SQLite file required for its operation. This means that the database - raw files must be installed somewhere in this case. With option ``a`` you can - run in `dummy` mode and only download the raw data files for the database - once you are happy with your setup. +2. You can download it in its source form from `its git repository + <http://github.com/bioidiap/bob.db.replay.git>`_. When you download the + version at the git repository, you will need to run a command to recreate + the backend SQLite file required for its operation. This means that the + database raw files must be installed somewhere in this case. With option + ``a`` you can run in `dummy` mode and only download the raw data files for + the database once you are happy with your setup. You can mix and match points 1/2 and a/b above based on your requirements. Here are some examples: diff --git a/setup.py b/setup.py index 9e5b26a7eda3e045345f0e5c68ca198d8c5df379..726fdceba1dffbc96d7d457cc1ac4eab2892d51f 100644 --- a/setup.py +++ b/setup.py @@ -36,7 +36,7 @@ setup( entry_points={ 'console_scripts': [ # for tests or db creation, enable the following line: - #'driver.py = bob.db.script.dbmanage:main', + #'replay_manager.py = bob.db.script.dbmanage:main', ], 'bob.db': [ 'replay = replay.db',