Added README.md file

This commit is contained in:
Michaël Lemaire 2014-02-09 17:05:01 +01:00
parent 16d7ae7547
commit 1a0fe22ac9
3 changed files with 31 additions and 21 deletions

1
.gitignore vendored
View file

@ -21,3 +21,4 @@ ui_*.h
/*.trace
/paysages3d-linux/
/paysages3d-linux.tar.bz2
/config.vim

View file

@ -1,4 +1,31 @@
paysages3d
==========
Paysages 3D
===========
Landscape generator, modeler and 3d renderer software
About
-----
[Paysages 3D](http://www.paysages3d.com) is a work-in-progress landscape generator, modeler and renderer software.
It is written in C++ 11, using Qt 5.2 as only dependency.
Build/Run
---------
At the moment, the build system is only well tested using the latest [QtSDK](http://qt-project.org/downloads) installation, and [QtCreator](http://qt-project.org/downloads#qt-creator). Later work will remove this dependency.
Simply open the *src/paysages.pro* file in QtCreator, and make a shadow build.
You can then run the compiled program **from the top project directory** (the one that contains *src* and *data*).
Licensing
---------
The source code is subject to the terms of the [Mozilla Public License, v. 2.0](http://mozilla.org/MPL/2.0/). Read the full terms in the LICENSE file.
Credits
-------
* [Michaël Lemaire](http://thunderk.net) - Main developer
* [Eric Bruneton and Fabrice Neyet](http://www-evasion.imag.fr/Membres/Eric.Bruneton/) - Publication and source code from *Precomputed Atmospheric Scattering (2008)*
* [Qt](http://qt.nokia.com/) - Library in use
* [GoogleTest](https://code.google.com/p/googletest/) - Included library

View file

@ -1,18 +0,0 @@
function! UpdateTags()
!ctags --recurse=yes ./src/
endfunction
function! RunDebug()
UpdateTags()
!make BUILDMODE=debug all run_qt
endfunction
function! RunRelease()
UpdateTags()
!make BUILDMODE=debug all run_qt
endfunction
map <silent> <S-F9> :call RunDebug()<CR>
map <silent> <S-F10> :call RunRelease()<CR>
map <silent> <F11> :!make tests<CR>