API docs fixes
[vng.git] / README
blobc63f82bdc4894271a4fd35ef52e6227dc9247784
1 Compiling
2 =========
3 To compile this project you need Qt4, only the qt-core library is used.
4 This is tested to work on Qt4.3 and Qt4.4.
6 To generate a makefile call the 'qmake' command in the vng directory.  Make
7 sure you call the one from the right Qt release.
8 Some linux distros ship this command names 'qmake-qt4'
10 After calling qmake, compile the project like you would any other.  This is
11 platform dependent and could be "nmake", "make" etc.
13 You will find the "vng" command line in the build directory, on Windows it will
14 be in a subdirectory like debug\vng.exe or release\vng.exe.
16 Thats all!
19 Pushing & Committing
20 ====================
22 if you make any changes to the sourcecode, it would be great if you can share that with us.
23 The hosting site http://repo.or.cz/w/vng.git allows you to share your recorded changes
24 with minimal fuss with us.
25 After recording your changes all you need to do is to call
26   git push git+ssh://repo.or.cz/srv/git/vng.git +master:mob
27 this will push your changes so the rest of the world can see them.  Be sure to write
28 easy to understand comments for your commits!
31 Have fun.