diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..9bea3f0920b6aac90c75bb8708fe217c56d5bdd5 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# SIONfwd + +SIONfwd is a home-grown solution for I/O forwarding for SIONlib. +It contains a C++ server and a C client library. + +## Requirements + +- C compiler with support for C99 +- C++ compiler with support for C++17 +- CMake 3.12 or newer +- MPI 3.0 or newer + +## Installation + +Build and install follows the usual CMake procdure, e.g.: + +``` +$ cmake -S . -B build +$ cmake --build build +$ cmake --install build +``` + +## Usage + +TODO + +## License + +[MIT](https://opensource.org/licenses/MIT)