Commit b0b627f2 authored by André Anjos's avatar André Anjos 💬

Merge branch 'readme-and-dev' into 'master'

Improve README and update dev environment

See merge request !264
parents 8ad24fec 8bff2648
Pipeline #25505 passed with stages
in 17 minutes and 40 seconds
......@@ -21,22 +21,34 @@
.. with the BEAT platform. If not, see http://www.gnu.org/licenses/. ..
============================================
Biometrics Evaluation and Testing Platform
============================================
.. image:: https://img.shields.io/badge/docs-stable-yellow.svg
:target: https://www.idiap.ch/software/beat/docs/beat/beat.web/stable/
.. image:: https://img.shields.io/badge/docs-latest-orange.svg
:target: https://www.idiap.ch/software/beat/docs/beat/beat.web/master/
.. image:: https://gitlab.idiap.ch/beat/beat.web/badges/master/build.svg
:target: https://gitlab.idiap.ch/beat/beat.web/commits/master
.. image:: https://gitlab.idiap.ch/beat/beat.web/badges/master/coverage.svg
:target: https://gitlab.idiap.ch/beat/beat.web/commits/master
.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
:target: https://gitlab.idiap.ch/beat/beat.web
.. image:: https://img.shields.io/pypi/v/beat.web.svg
:target: https://pypi.python.org/pypi/beat.web
The BEAT platform is written as a set of python packages. This package
(beat.web), in particular, constitutes the central deployment pillar of BEAT
platform instance. It uses as a base development library, a web framework
called Django_. If you are unfamiliar with this framework, but wishes to deploy
or develop the BEAT platform, it is recommended you familiarize yourself with
it.
===================
BEAT Web Platform
===================
This package part of BEAT_, an open-source evaluation platform for data science
algorithms and workflows. It contains source code for the online platform of
BEAT.
Installation
------------
Here is a recipe to get you started::
Start by downloading and installing miniconda_. Then, to install this package,
run::
$ conda env create -f dev.yml
$ conda activate beat-web
......@@ -47,27 +59,15 @@ These commands should download and install all non-installed dependencies and
get you a fully operational test and development environment.
Documentation
-------------
To build the administrator guide, just do::
$ ./bin/sphinx-build doc/admin html/admin
Once the guide is built, continue reading on the "Installation" section for
further deployment instructions.
Issues
------
If you find problems concerning this package, please post a message to our
`group mailing list`_. Currently open issues can be tracked at `our gitlab
page`_.
Contact
-------
For questions or reporting issues to this software package, contact our
development `mailing list`_.
.. Place here references to all citations in lower case
.. _django: https://www.djangoproject.com/
.. _group mailing list: https://groups.google.com/d/forum/beat-devel
.. _our gitlab page: https://gitlab.idiap.ch/beat/beat.web/issues
.. Place your references here:
.. _beat: https://www.idiap.ch/software/beat
.. _installation: https://www.idiap.ch/software/beat/install
.. _mailing list: https://www.idiap.ch/software/beat/discuss
.. _miniconda: https://conda.io/miniconda.html
......@@ -7,7 +7,7 @@ dependencies:
# packages you may pin are here
- python=3.6
- bob-devel=2018.12.11
- beat-devel=2018.12.12
- beat-devel=2018.12.15
# requirements.txt, they are indirectly pinned through the above
- beat.core
......
Markdown is supported
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