vcglib/docs/Doxygen/install.dxy

/** \page install

Installation and folder structure
================

VCG Lib uses a git repository hosted by github. 
The main project page of the library is http://github.com/cnr-isti-vclab/vcglib/

The stable version of the library are available under the release page 
https://github.com/cnr-isti-vclab/vcglib/releases

To get the development version of library clone the 'devel' branch of the library :

     git clone -b devel https://github.com/cnr-isti-vclab/vcglib.git   


Folder Structure
================
VCGLib is mostly made of header files (and its core part it's only header files) with no external dependencies.
Just download the tarball from here and uncompress it in a folder, e.g. named vcg, inside you compiler "include" directory.
Afterwards, you have to just include the files you need as shown in the apps/sample examples.

Inside vcg folder you will find 5 sub-folders:

- `vcg`: this is the core of the library, where all the algorithms and data structures are defined. This part is pure, quite heavily templated, C++ code with STL support for common data structures and algorithms. You will not find a single include from here to anything else than standard libraries. Note that core part is made of header files (.h files) only.
- `wrap`: here you will find the wrapping of VCG concepts towards specific needs/contexts/libraries. For example you will find all the code to import/export meshes from the hard disk in many formats, or the routines for rendering triangle meshes with OpenGL, supports for common GUI tools like a trackball, and so on..
- `apps`: this folder contains the command line applications developed with the VCG Lib. Many (much more) examples can be found in MeshLab. The apps/sample directory contains a sub-collection of very basic apps. A good starting point for beginners!
- `docs`: documentation lives here (including this tutorial)
- `eigenlib` a copy of the latest stable version of the eigen library for linear algebra ( http://http://eigen.tuxfamily.org/ ). VCGlib relies on eigen for all the advanced matrix  processing.
*/
corrected in the doxy the address of the svn server 2013-04-28 23:25:47 +02:00			`/** \page install`
First version of the new doxygen based documentation 2012-10-03 13:56:27 +02:00
			`Installation and folder structure`
			`================`

updated documentation to reflect the github transfer 2016-06-27 11:12:33 +02:00			`VCG Lib uses a git repository hosted by github.`
			`The main project page of the library is http://github.com/cnr-isti-vclab/vcglib/`
corrected links to the svn repository in the doxy 2013-06-25 12:23:25 +02:00
updated documentation to reflect the github transfer 2016-06-27 11:12:33 +02:00			`The stable version of the library are available under the release page`
			`https://github.com/cnr-isti-vclab/vcglib/releases`
First version of the new doxygen based documentation 2012-10-03 13:56:27 +02:00
updated documentation to reflect the github transfer 2016-06-27 11:12:33 +02:00			`To get the development version of library clone the 'devel' branch of the library :`
First version of the new doxygen based documentation 2012-10-03 13:56:27 +02:00
updated documentation to reflect the github transfer 2016-06-27 11:12:33 +02:00			`git clone -b devel https://github.com/cnr-isti-vclab/vcglib.git`
First version of the new doxygen based documentation 2012-10-03 13:56:27 +02:00

			`Folder Structure`
			`================`
updated documentation to reflect the github transfer 2016-06-27 11:12:33 +02:00			`VCGLib is mostly made of header files (and its core part it's only header files) with no external dependencies.`
First version of the new doxygen based documentation 2012-10-03 13:56:27 +02:00			`Just download the tarball from here and uncompress it in a folder, e.g. named vcg, inside you compiler "include" directory.`
updated documentation to reflect the github transfer 2016-06-27 11:12:33 +02:00			`Afterwards, you have to just include the files you need as shown in the apps/sample examples.`
First version of the new doxygen based documentation 2012-10-03 13:56:27 +02:00
corrected links to the svn repository in the doxy 2013-06-25 12:23:25 +02:00			`Inside vcg folder you will find 5 sub-folders:`
First version of the new doxygen based documentation 2012-10-03 13:56:27 +02:00
			- `vcg`: this is the core of the library, where all the algorithms and data structures are defined. This part is pure, quite heavily templated, C++ code with STL support for common data structures and algorithms. You will not find a single include from here to anything else than standard libraries. Note that core part is made of header files (.h files) only.
			- `wrap`: here you will find the wrapping of VCG concepts towards specific needs/contexts/libraries. For example you will find all the code to import/export meshes from the hard disk in many formats, or the routines for rendering triangle meshes with OpenGL, supports for common GUI tools like a trackball, and so on..
updated documentation to reflect the github transfer 2016-06-27 11:12:33 +02:00			- `apps`: this folder contains the command line applications developed with the VCG Lib. Many (much more) examples can be found in MeshLab. The apps/sample directory contains a sub-collection of very basic apps. A good starting point for beginners!
First version of the new doxygen based documentation 2012-10-03 13:56:27 +02:00			- `docs`: documentation lives here (including this tutorial)
corrected links to the svn repository in the doxy 2013-06-25 12:23:25 +02:00			- `eigenlib` a copy of the latest stable version of the eigen library for linear algebra ( http://http://eigen.tuxfamily.org/ ). VCGlib relies on eigen for all the advanced matrix processing.
First version of the new doxygen based documentation 2012-10-03 13:56:27 +02:00			`*/`