commit c98790a092febcabc9e8acf107692dc887d0dd7d parent 326097e5d1b92a720e6eff163d4ebb8842c75dff Author: Benjamin Piaud <benjamin.piaud@meso-star.com> Date: Tue, 2 Aug 2022 18:21:14 +0200 Add README Diffstat:
| A | README.md | | | 35 | +++++++++++++++++++++++++++++++++++ |
1 file changed, 35 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -0,0 +1,35 @@ +# City Generator 2 + +The purpose of "City Generator 2" is to produce the .stl files that can be used +by volumic solver software like the +[Stardis](https://gitlab.com/meso-star/star-cad) program. It's designed to +produce conformal mesh which describe a city. + +## How to build + +It relies the +[CMake](http://www.cmake.org) and the +[RCMake](https://gitlab.com/vaplv/rcmake/) packages to build. It also depends +on the +[RSys](https://gitlab.com/vaplv/rsys/), +[Star-CAD](https://gitlab.com/meso-star/star-cad), +libraries. + +First ensure that CMake is installed on your system. Then install the RCMake +package as well as the aforementioned prerequisites. Finally generate the +project from the `cmake/CMakeLists.txt` file by appending to the +`CMAKE_PREFIX_PATH` variable the install directories of its dependencies. The +resulting project can be edited, built, tested and installed as any CMake +project. Refer to the [CMake documentation](https://cmake.org/documentation) +for further informations on CMake. + +## Copyright notice + +Copyright (C) 2022 Université de Pau et des Pays de l'Adour UPPA +Copyright (C) 2022 [|Méso|Star>](https://www.meso-star.com) (<contact@meso-star.com>) + +## License + +Rad-Net Ground is free software released under the GPL v3+ license: GNU GPL +version 3 or later. You are welcome to redistribute it under certain +conditions; refer to the COPYING file for details.