Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mattdawkins committed Feb 8, 2018
1 parent 5a5bded commit e0313b9
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 14 deletions.
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,7 @@ or added to your path to use them.
Quick Build Instructions
------------------------

More in-depth build instructions can be found [here](examples/building_viame/README.rst),
with additional tips [here](examples/building_viame/README.rst#build-tips-n-tricks),
and common issues [here](examples/building_viame/README.rst#known-issues).

More in-depth build instructions can be found [here](examples/building_viame), but
VIAME itself can be built either as a super-build, which builds most of its
dependencies alongside itself, or standalone. To build VIAME requires, at a minimum,
[Git](https://git-scm.com/), [CMake](https://cmake.org/), and a C++ compiler.
Expand Down
19 changes: 12 additions & 7 deletions examples/building_viame/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,21 @@ Ubuntu 14.04+.
Install Dependencies
====================

Some of the dependencies required for VIAME can be installed with one quick and easy
instruction with no configuration required. Different Linux distributions may have
different packages already installed, or may use a different package manager than
apt, but on Ubuntu this should help to provide a starting point.
Different Linux distributions may have different packages already installed, or may
use a different package manager than apt, but on Ubuntu this should help to provide
a starting point.

.. code-block:: bash
sudo apt-get install git zlib1g-dev libcurl4-openssl-dev libexpat1-dev dh-autoreconf liblapack-dev libxt-dev
sudo apt-get build-dep libboost-all-dev qt5-default
If using VIAME_ENABLE VIVIA for building GUIs, you also may need to run:

.. code-block:: bash
sudo apt-get build-dep qt5-default
If using VIAME_ENABLE_PYTHON, you also may need to install python2.7, python2.7-dev, and numpy, e.g.:

.. code-block:: bash
Expand All @@ -48,14 +53,14 @@ If using VIAME_ENABLE_PYTHON, you also may need to install python2.7, python2.7-
If using VIAME_ENABLE_CUDA for GPU support, you should install CUDA:

..code-blocks:: bash
.. code-blocks:: bash

https://developer.nvidia.com/cuda-80-ga2-download-archive

Install CMAKE
=============

Depending on the OS, the version of cmake you get with apt/yum is often too old to
Depending on the OS, the version of cmake you get with apt/yum/dnf is often too old to
use for VIAME (you currently need at least CMake 3.3) so you may need to do a manual
install. Go to the cmake website, ``https://cmake.org/download``, and download the
appropriate binary distribution (for Ubuntu, this would be something like
Expand Down Expand Up @@ -164,7 +169,7 @@ and run the following commands:
mkdir [build-directory]
cd [build-directory]
cmake [build_flags] [path_to_source_tree]
make # or make -j10 for a threaded build
make -j8 # or just make for a unthreaded build
Depending on which enable flags you have set and your system configuration, you may
need to set additional cmake variables to point to dependency locations. An example
Expand Down
6 changes: 3 additions & 3 deletions examples/detection_file_conversions/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ New formats can be integrated to the system by implementing a derived version of
vital::algo::detected_object_set_input class in C++, or via making a python process which
produces detected_object_sets or object_track_sets.

| CSV - Default Comma Seperated Value Detection Format
| **bold** CSV - Default Comma Seperated Value Detection Format
|
| The default CSV format contains 1 detection per line, with each line as follows:
|
Expand All @@ -39,7 +39,7 @@ produces detected_object_sets or object_track_sets.
| - 7: detection confidence
| - 8,9+ : class-name score (this pair may be omitted or repeated)
|
| KW18 - Kitware KW18 Column Seperated Track Format
| **bold** KW18 - Kitware KW18 Column Seperated Track Format
|
| KW18s are a space seperated file format for representing detections or tracks.
|
Expand All @@ -49,7 +49,7 @@ produces detected_object_sets or object_track_sets.
| 11:Img-bbox(TL_y) 12:Img-bbox(BR_x) 13:Img-bbox(BR_y) 14:Area 15:World-loc(x)
| 16:World-loc(y) 17:World-loc(z) 18:timestamp 19:track-confidence
|
| HABCAM - Annotation format used by the HabCam project
| **bold** HABCAM - Annotation format used by the HabCam project
|
| A typical habcam annotation looks like:
|
Expand Down

0 comments on commit e0313b9

Please sign in to comment.