Merge pull request #129 from alicevision/doc/updateVcpkg

[doc] update with vcpkg package

README.md

@@ -6,8 +6,9 @@
 PopSift is an open-source implementation of the SIFT algorithm in CUDA.
 PopSift tries to stick as closely as possible to David Lowe's famous paper [1], while extracting features from an image in real-time at least on an NVidia GTX 980 Ti GPU.
 
-## HW requirements
+Check out the [documentation](https://popsift.readthedocs.io/) for more info.
 
+## HW requirements
 
 PopSift compiles and works with NVidia cards of compute capability >= 3.0 (including the GT 650M), but the code is developed with the compute capability 5.2 card GTX 980 Ti in mind.
 
@@ -44,15 +45,6 @@ Some build options are available:
 
 * `BUILD_SHARED_LIBS` (default: `ON`) controls the type of library to build (`ON` for shared libraries, `OFF` for static)
 
-
-### Continuous integration:
-- [![Build Status](https://travis-ci.org/alicevision/popsift.svg?branch=master)](https://travis-ci.org/alicevision/popsift) master branch.
-- [![Build Status](https://travis-ci.org/alicevision/popsift.svg?branch=develop)](https://travis-ci.org/alicevision/popsift) develop branch.
-- [![Build status](https://ci.appveyor.com/api/projects/status/rsm5269hs288c2ji/branch/develop?svg=true)](https://ci.appveyor.com/project/AliceVision/popsift/branch/develop)
- develop branch.
-
-
-
 ## Usage
 
 The main artifact created is `libpopsift`.
@@ -84,8 +76,6 @@ Then, in order to build just pass the location of `PopSiftConfig.cmake` from the
 cmake .. -DPopSift_DIR=<prefix>/lib/cmake/PopSift/
 ```
 
-
-
 ### Calling the API
 
 The caller must create a `popart::Config` struct (documented in `src/sift/sift_conf.h`) to control the behaviour of the PopSift, and instantiate an object of class `PopSift` (found in `src/sift/popsift.h`).
@@ -109,6 +99,11 @@ PopSift can be configured at runtime to use constants that affect it behaviours.
 In particular, users can choose to generate results very similar to VLFeat or results that are closer (but not as close) to the SIFT implementation of the OpenCV extras.
 We acknowledge that there is at least one SIFT implementation that is vastly faster, but it makes considerable sacrifices in terms of accuracy and compatibility.
 
+## Continuous integration:
+- [![Build Status](https://travis-ci.org/alicevision/popsift.svg?branch=master)](https://travis-ci.org/alicevision/popsift) master branch.
+- [![Build Status](https://travis-ci.org/alicevision/popsift.svg?branch=develop)](https://travis-ci.org/alicevision/popsift) develop branch.
+- [![Build status](https://ci.appveyor.com/api/projects/status/rsm5269hs288c2ji/branch/develop?svg=true)](https://ci.appveyor.com/project/AliceVision/popsift/branch/develop)
+  develop branch.
 
 ## License
 

doc/sphinx/source/install/install.rst

@@ -50,9 +50,20 @@ vcpkg
 
 `vcpkg <https://github.com/microsoft/vcpkg>`_ is a cross-platform (Windows, Linux and MacOS), open-source package manager created by Microsoft.
 
-We are planning to release a port of the library so that it can be easily built using the package manager on all supported platforms.
-Stay tuned!
+Starting from v0.9, PopSift package can be installed on each platform via vcpkg.
+To install the library:
 
+.. code:: shell
+
+  vcpkg install popsift --triplet <arch>
+
+where :code:`<arch>` is the architecture to build for (e.g. :code:`x64-windows`, :code:`x64-linux-dynamic` etc.)
+
+If you want to install the demo applications that come with the library you can add the option :code:`apps`:
+
+.. code:: shell
+
+  vcpkg install popsift[apps] --triplet <arch>
 
 ------------