Update README.md

This commit is contained in:
2023-03-18 09:49:16 +01:00
parent 8f8cc94ddb
commit 3b3d472149
+12 -1
View File
@@ -3,4 +3,15 @@ LibXISF
LibXISF is C++ library that can read and write XISF files produced by [PixInsight](https://pixinsight.com/). LibXISF is C++ library that can read and write XISF files produced by [PixInsight](https://pixinsight.com/).
It implement [XISF 1.0 specification](https://pixinsight.com/doc/docs/XISF-1.0-spec/XISF-1.0-spec.html). It implement [XISF 1.0 specification](https://pixinsight.com/doc/docs/XISF-1.0-spec/XISF-1.0-spec.html).
It is licensed under GPLv3. To compile you will need C++17 compiler. It is licensed under GPLv3 or later. To compile you will need C++17 compiler.
To compile simply run these commands
```
cmake -B build -S .
cmake --build build --parallel
cmake --install .
```
By default it use bundled libraries. If you wish to use external libraries you will may add
`-DUSE_BUNDLED_LIBS=Off` to first command. Then you will need *lz4 pkg-config pugixml zlib* installed.
You may also specify `-DBUILD_SHARED_LIBS=Off` if you want build static lib.