diff --git a/README.md b/README.md new file mode 100644 index 0000000..fda3df6 --- /dev/null +++ b/README.md @@ -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 +```