Skip to content
Snippets Groups Projects
Commit 3b976d28 authored by André Anjos's avatar André Anjos :speech_balloon:
Browse files

Doc mods

parent 99f3fae3
No related branches found
No related tags found
No related merge requests found
...@@ -12,27 +12,27 @@ You would normally not install this package unless you are maintaining it. What ...@@ -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. 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: There are a few ways to achieve this:
1. You can add this package as a requirement at the ``setup.py`` for your own 1. You can add this package as a requirement at the ``setup.py`` for your own
`satellite package `satellite package
<https://github.com/idiap/bob/wiki/Virtual-Work-Environments-with-Buildout>`_ <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 or to your Buildout ``.cfg`` file, if you prefer it that way. With this
method, this package gets automatically downloaded and installed on your method, this package gets automatically downloaded and installed on your
working environment, or working environment, or
2. You can manually download and install this package using commands like 2. You can manually download and install this package using commands like
``easy_install`` or ``pip``. ``easy_install`` or ``pip``.
The package is available in two different distribution formats: 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 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 <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 version at the git repository, you will need to run a command to recreate
backend SQLite file required for its operation. This means that the database the backend SQLite file required for its operation. This means that the
raw files must be installed somewhere in this case. With option ``a`` you can database raw files must be installed somewhere in this case. With option
run in `dummy` mode and only download the raw data files for the database ``a`` you can run in `dummy` mode and only download the raw data files for
once you are happy with your setup. 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 You can mix and match points 1/2 and a/b above based on your requirements. Here
are some examples: are some examples:
......
...@@ -36,7 +36,7 @@ setup( ...@@ -36,7 +36,7 @@ setup(
entry_points={ entry_points={
'console_scripts': [ 'console_scripts': [
# for tests or db creation, enable the following line: # 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': [ 'bob.db': [
'replay = replay.db', 'replay = replay.db',
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment