diff --git a/.gitignore b/.gitignore index b25add8..8d7a6b3 100644 --- a/.gitignore +++ b/.gitignore @@ -21,3 +21,4 @@ ui_*.h /*.trace /paysages3d-linux/ /paysages3d-linux.tar.bz2 +/config.vim diff --git a/README.md b/README.md index 6e27bcd..15ec617 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/config.vim b/config.vim deleted file mode 100644 index 9544134..0000000 --- a/config.vim +++ /dev/null @@ -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 :call RunDebug() -map :call RunRelease() -map :!make tests -