Skip to content

Commit 928d78a

Browse files
committed
Update of README file
1 parent fa00f56 commit 928d78a

File tree

1 file changed

+40
-1
lines changed

1 file changed

+40
-1
lines changed

README.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,42 @@
11
# OpenFLUID LandR library
22

3-
**WARNING: The OpenFLUID LandR library sources are currently being migrated. They cannot currently be built correctly and should not be used.**
3+
The OpenFLUID LandR (`openfluid-landr`) library is a C++ library for topological processing of geometries, focused on digital representation of landscapes geometries.
4+
It was formerly part of the [OpenFLUID software sources](https://github.com/OpenFLUID).
5+
6+
7+
The `openfluid-landr` library relies on the following sofware
8+
9+
* [OpenFLUID framework](https://openfluid-project.org)
10+
* [GEOS library](https://trac.osgeo.org/geos)
11+
* [Boost library](https://www.boost.org/)
12+
13+
:warning: **Due to major breaking changes in GEOS dependency, the openfluid-landr source code is not currently stable and does not compile as is**
14+
15+
16+
## Build
17+
18+
_NOTE: The build of openfluid-landr library has only been tested on Linux systems (Ubuntu 18.04 and 20.04)_
19+
20+
21+
It requires the [GCC compiler](https://gcc.gnu.org/) compiler and the [CMake configuration tool](https://cmake.org/) to be built.
22+
23+
* Create the build directory in the sources directory
24+
```txt
25+
mkdir _build
26+
cd _build
27+
```
28+
29+
* Configure the build
30+
```txt
31+
cmake ..
32+
```
33+
34+
* Execute the build
35+
```txt
36+
make
37+
```
38+
39+
* Run the tests
40+
```txt
41+
ctest
42+
```

0 commit comments

Comments
 (0)