From cd3f0461bfde17630354a4cb82c00a039128d9f4 Mon Sep 17 00:00:00 2001 From: Paolo Cignoni Date: Mon, 27 Jun 2016 11:12:33 +0200 Subject: [PATCH] updated documentation to reflect the github transfer --- apps/tridecimator/tridecimator.cpp | 1 - docs/Doxygen/install.dxy | 23 +++++++++-------------- 2 files changed, 9 insertions(+), 15 deletions(-) diff --git a/apps/tridecimator/tridecimator.cpp b/apps/tridecimator/tridecimator.cpp index 6f4bc513..51c66bec 100644 --- a/apps/tridecimator/tridecimator.cpp +++ b/apps/tridecimator/tridecimator.cpp @@ -73,7 +73,6 @@ void Usage() "---------------------------------\n" " TriDecimator 1.0 \n" " http://vcg.isti.cnr.it\n" - " http://vcg.sourceforge.net\n" " release date: " __DATE__ "\n---------------------------------\n\n" "Copyright 2003-2016 Visual Computing Lab I.S.T.I. C.N.R.\n" diff --git a/docs/Doxygen/install.dxy b/docs/Doxygen/install.dxy index a1831cfb..5d72f675 100644 --- a/docs/Doxygen/install.dxy +++ b/docs/Doxygen/install.dxy @@ -3,33 +3,28 @@ Installation and folder structure ================ -VCG Lib uses a SVN repository hosted by sourceforge. -The main project page of the library is http://sourceforge.net/projects/vcg/ +VCG Lib uses a git repository hosted by github. +The main project page of the library is http://github.com/cnr-isti-vclab/vcglib/ -To get the right subset of the svn trunk in the devel folder you should issue the following svn command: +The stable version of the library are available under the release page +https://github.com/cnr-isti-vclab/vcglib/releases - svn checkout svn://svn.code.sf.net/p/vcg/code/trunk/vcglib vcglib +To get the development version of library clone the 'devel' branch of the library : -Windows users with tortoisesvn (http://www.tortoisesvn.net) installed should + git clone -b devel https://github.com/cnr-isti-vclab/vcglib.git -1. create a folder named vcglib. -2. right-click in the newly created vcglib folder and choose SVN Checkout -3. put in the first parameter: svn://svn.code.sf.net/p/vcg/code/trunk/vcglib -4. press ok and wait, it should start to check out the last revision of the whole tree. Folder Structure ================ -VCG Lib is mostly made of header files (and its core part it's only header files). +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 file you need. +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/simple directory contains a sub-collection of very basic apps. A good starting point for beginners! +- `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. - -You can browse the svn tree on the sourceforge page http://sourceforge.net/p/vcg/code/HEAD/tree/trunk/vcglib/ */