Commit b3a14616 authored by Manuel Günther's avatar Manuel Günther
Browse files

Updated README

parent f9982baf
Example buildout environment .. vim: set fileencoding=utf-8 :
============================ .. Andre Anjos <andre.anjos@idiap.ch>
.. Thu 30 Jan 08:46:53 2014 CET
This simple example demonstrates how to wrap Bob-based scripts on buildout .. image:: http://img.shields.io/badge/docs-stable-yellow.png
environments. This may be useful for homework assignments, tests or as a way to :target: http://pythonhosted.org/bob.bio.face/index.html
distribute code to reproduce your publication. In summary, if you need to give .. image:: http://img.shields.io/badge/docs-latest-orange.png
out code to others, we recommend you do it following this template so your code :target: https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.bio.face/master/index.html
can be tested, documented and run in an orderly fashion. .. image:: http://travis-ci.org/bioidiap/bob.bio.face.svg?branch=master
:target: https://travis-ci.org/bioidiap/bob.bio.face?branch=master
.. image:: https://coveralls.io/repos/bioidiap/bob.bio.face/badge.png?branch=master
:target: https://coveralls.io/r/bioidiap/bob.bio.face?branch=master
.. image:: https://img.shields.io/badge/github-master-0000c0.png
:target: https://github.com/bioidiap/bob.bio.face/tree/master
.. image:: http://img.shields.io/pypi/v/bob.bio.face.png
:target: https://pypi.python.org/pypi/bob.bio.face
.. image:: http://img.shields.io/pypi/dm/bob.bio.face.png
:target: https://pypi.python.org/pypi/bob.bio.face
Installation =================================
------------ Run face recognition algorithms
=================================
This package contains functionality to run face recognition experiments.
It is an extension to the `bob.bio.base <http://pypi.python.org/pypi/bob.bio.base>`_ package, which provides the basic scripts.
In this package, utilities that are specific for face recognition are contained, such as:
.. note:: * Image databases
* Image preprocesors, including face detection and facial image alignment
* Image feature extractors
* Recognition algorithms based on image features
To follow these instructions locally you will need a local copy of this
package. For that, you can use the github tarball API to download the package::
$ wget --no-check-certificate https://github.com/idiap/bob.project.example/tarball/master -O- | tar xz Installation
$ mv idiap-bob.project* bob.project.example ------------
To install this package -- alone or together with other `Packages of Bob <https://github.com/idiap/bob/wiki/Packages>`_ -- please read the `Installation Instructions <https://github.com/idiap/bob/wiki/Installation>`_.
For Bob_ to be able to work properly, some dependent packages are required to be installed.
Please make sure that you have read the `Dependencies <https://github.com/idiap/bob/wiki/Dependencies>`_ for your operating system.
Documentation and Further Information Documentation
------------------------------------- -------------
For further documentation on this package, please read the `Stable Version <http://pythonhosted.org/bob.bio.face/index.html>`_ or the `Latest Version <https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.bio.face/master/index.html>`_ of the documentation.
For a list of tutorials on this or the other packages ob Bob_, or information on submitting issues, asking questions and starting discussions, please visit its website.
Please refer to the latest Bob user guide, accessing from the `Bob website .. _bob: https://www.idiap.ch/software/bob
<http://idiap.github.com/bob/>`_ for how to create your own packages based on
this example. In particular, the Section entitled `Organize Your Work in
Satellite Packages <http://www.idiap.ch/software/bob/docs/releases/last/sphinx/html/OrganizeYourCode.html>`_
contains details on how to setup, build and roll out your code.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment