Commit a895761d authored by Johnny Jazeix's avatar Johnny Jazeix

Completion de doc

parent aa098514
To compile the project ViTE : This is ViTE version 1.0.
ViTE is a C++ visualisator of Traces Execution using Qt for viewing.
Visit : http://www.qtsoftware.com/downloads/opensource/appdev and download the development files for your operating system. INSTALLING ViTE
Install also GLUT.
On Windows, please refer to the how_to_install.txt file in the windows.tar.gz file.
On MacOS X or Debian, follow the next step.
COMPILING ViTE
If you do not have Qt please visit : http://www.qtsoftware.com/downloads/opensource/appdev and download the development files for your operating system.
Install also GLUT (http://www.opengl.org/resources/libraries/glut/).
For Debian/Ubuntu users, you can use apt-get : For Debian/Ubuntu users, you can use apt-get :
sudo apt-get install libqt4-dev libqt4-opengl-dev libglut3-dev sudo apt-get install libqt4-dev libqt4-opengl-dev libglut3-dev
sudo apt-get install libglew-dev sudo apt-get install libglew-dev
For Debian users, you may need to install also the qmake package. For Debian users, you may need to install also the qmake package.
Then, until Qt development files are installed, you can compile ViTE :
./configure will configure your Makefile depending on your OS.
make will create the binary files
DOCUMENTATION
For ViTE there is three documentations that can be found in documentation folder.
The first one is the user manual which can be useful for a first use.
The two other ones are for developpers : this is the technical manual and the Doxygen generated doc. The technical manual explains how ViTE is coded and the Doxygen explains the classes and functions more in details.
For Doxygen, it is necessary to have epstopdf for the latex version. You can install it with the package texlive-extra-utils. For Doxygen, it is necessary to have epstopdf for the latex version. You can install it with the package texlive-extra-utils.
Also, install the dot program for graphics from the package graphviz. Also, install the dot program for graphics from the package graphviz.
The doxygen documentation can be compiled by the command : make doc.
Then, until Qt development files are installed, you can compile ViTE :
./configure will configure your Makefile depending on your OS.
make will create the binary files SUPPORTED PLATFORMS
make doc will generate the doxygen documentation for developpers. These files will be placed in the documentation folder. For this release, the following platforms have been tested on :
The technical and user documentations are also in the documentation folder. - Ubuntu 8.04 / 8.10.
- Windows Xp/Vista.
- Mandriva linux one 2009 kde (under virtualbox).
- MacOS X.
make clean -> remove object files generated by the compiler. HOW TO REPORT A BUG
If you think you have found a bug in ViTE, you can report it by mail at vite-developpeurs@lists.gforge.inria.fr or in the forum at https://gforge.inria.fr/forum/?group_id=1596
\ No newline at end of file
...@@ -71,6 +71,7 @@ doc: ...@@ -71,6 +71,7 @@ doc:
clean: clean:
cd ./src && make clean cd ./src && make clean
\$(RM) log.txt
@echo " " @echo " "
@echo "Cleaned!" @echo "Cleaned!"
@echo " " @echo " "
...@@ -80,7 +81,11 @@ cleanall: clean ...@@ -80,7 +81,11 @@ cleanall: clean
make -C \$(DOC)/user_manual cleanall make -C \$(DOC)/user_manual cleanall
make -C \$(DOC)/technical_manual cleanall make -C \$(DOC)/technical_manual cleanall
@(cd bin/ && rm -rf vite) @(cd bin/ && rm -rf vite)
@(cd ../documentation/ && rm -rf html/ latex/) @(cd ../documentation/ && \$(RM) html/ latex/)
distclean: cleanall
\$(RM) Makefile
\$(RM) src/Makefile
#To remember how to create automaticaly a src.pro #To remember how to create automaticaly a src.pro
#build: #build:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment