Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
mattdawkins committed Feb 5, 2018
1 parent b165f5e commit 16f317c
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 27 deletions.
47 changes: 25 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ Documentation
The [VIAME manual](http://viame.readthedocs.io/en/latest/) is more comprehensive,
but select entries are also listed below, which include run examples:

<br>

[Build and Install Guide](examples/building_viame/README.rst) > > >
[Tips and Tricks](examples/building_viame/README.rst#build-tips-n-tricks) > > >
Expand Down Expand Up @@ -71,17 +70,20 @@ but select entries are also listed below, which include run examples:
Pre-Built Binaries
------------------

Note: these binaries are currently very out-of-date, but will be updated in the near future. Source build is recommended.
Note: these binaries are currently very out-of-date, but will be updated in the near
future. Source build is recommended.

Windows binaries require an install of either [Anaconda2](https://www.continuum.io/downloads) (preferred) or a comparable Python2.7 with multiple packages.
Windows binaries require an install of either [Anaconda2](https://www.continuum.io/downloads)
(preferred) or a comparable Python2.7 with multiple packages.

[Windows 7/8/10, 64-Bit, GPU Version](https://data.kitware.com/api/v1/item/58fe4ad68d777f16d01e0445/download)

[Windows 7/8/10, 64-bit, CPU Version](https://data.kitware.com/api/v1/item/58fe4ac78d777f16d01e0442/download)

The matlab plugins in the above releases were built using matlab r2016. They may or may not work
with other versions. They were also moved to an "experimental" folder in the plugin directory, and can either
be moved back into the main plugin directory or added to your path to use them.
The matlab plugins in the above releases were built using matlab r2016. They may or
may not work with other versions. They were also moved to an "experimental" folder
in the plugin directory, and can either be moved back into the main plugin directory
or added to your path to use them.

[Ubuntu 14.04, 64-Bit, GPU Version](https://data.kitware.com/api/v1/item/58d9b38b8d777f0aef5d896a/download)

Expand All @@ -91,8 +93,8 @@ 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).
with additional tips [here](examples/building_viame/README.rst#build-tips-n-tricks),
and common issues [here](examples/building_viame/README.rst#known-issues).

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,
Expand All @@ -116,18 +118,19 @@ using 'ccmake' or the cmake GUI, and then build with the following command on Li

make -j8

Or alternatively by building it in Visual Studio or your compiler of choice on Windows.
The '-j8' tells the build to run multi-threaded using 8 threads, this is useful for a
faster build though if you get an error it can be difficult to know where it was, in which case running just
'make' might be more helpful. For Windows, currently VS2013 thru VS2015 (with only
early versions of 2017, not latest) are supported. If using CUDA, version 8.0 is
desired, along with Python 2.7. Other versions have yet to be tested extensively.
On Windows it can also be beneficial to use Anaconda to get multiple python packages.
Boost Python (turned on by default when Python is enabled) requires Numpy and a few other dependencies.
Or alternatively by building it in Visual Studio or your compiler of choice on
Windows. The '-j8' tells the build to run multi-threaded using 8 threads, this is
seful for a faster build though if you get an error it can be difficult to know
here it was, in which case running just 'make' might be more helpful. For Windows,
urrently VS2013 thru VS2015 (with only early versions of 2017, not latest) are
supported. If using CUDA, version 8.0 is desired, along with Python 2.7. Other
versions have yet to be tested extensively. On Windows it can also be beneficial
to use Anaconda to get multiple python packages. Boost Python (turned on by default
hen Python is enabled) requires Numpy and a few other dependencies.

There are several optional arguments to viame which control which plugins get built, such
as those listed below. If a plugin is enabled that depends on another dependency (such
as OpenCV) then the dependency flag will be forced to on.
There are several optional arguments to viame which control which plugins get built,
such as those listed below. If a plugin is enabled that depends on another dependency
such as OpenCV) then the dependency flag will be forced to on.


<center>
Expand Down Expand Up @@ -187,9 +190,9 @@ run this command if you get a "cannot fetch hash #hashid" error.
Quick Run Instructions
----------------------

If building from the source, all final compiled binaries are placed in the [build-directory]/install
directory, which is the same as the root directory in the pre-built binaries. This will hereby be
refered to as the [install-directory].
If building from the source, all final compiled binaries are placed in the
[build-directory]/install directory, which is the same as the root directory
in the pre-built binaries. This will hereby be refered to as the [install-directory].

One way to test the system is to see if you can run the examples in the [install-directory]/examples
folder, for example, the pipelined object detectors. There are some environment variables
Expand Down
10 changes: 5 additions & 5 deletions examples/building_viame/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@
Building VIAME From Source
==========================

|See the platform-specific guides below, though the process is similar for each.
See the platform-specific guides below, though the process is similar for each.
|
|Example location online:
Example location online:
|
|https://github.com/Kitware/VIAME/tree/master/examples/building_viame
https://github.com/Kitware/VIAME/tree/master/examples/building_viame
|
|Example location in VIAME installation:
Example location in VIAME installation:
|
|[viame-install]/examples/building_viame
[viame-install]/examples/building_viame


*****************
Expand Down

0 comments on commit 16f317c

Please sign in to comment.