add readme

This commit is contained in:
Carl Philipp Klemm 2025-01-20 17:02:52 +01:00
parent 08e0c2fe56
commit 3db3e0a0de

24
README.md Normal file
View File

@ -0,0 +1,24 @@
# KISS EIS Dataformaters
Dataformaters contains misc. data formating utilites that are used to transfer file types used by eisgenerator/eistype into forign formats
## Requirements
* You must be running unix or a unix-like os such as linux
* A c++17 compiler like gcc
* cmake
* libeisgenerator
* libkisstype
* git
## Build and instructions
```
$ git clone REPO_URL dataformaters
$ cd dataformaters
$ mkdir build
$ cd build
$ cmake ..
$ make
$ make install
```