diff --git a/README.md b/README.md index 8d053aa61f92a029a19154a9b8307cf3ee316398..2bab2640205bc755a9be9e5704f352cf38127ec9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,13 @@ -This projects implements a FMU client which performs the simulation in (soft) realtime. +# ModeliChart Backend -The backend is controlled via grpc (googles remote procedure call framework), see https://git.rwth-aachen.de/ModeliChart/ModeliProtocol. -The protocol must be compiled for the platform on which it will be deployed. \ No newline at end of file +This projects implements a FMU client which performs the simulation in realtime. +Linux and Windows are supported. + +# Requirements +For the protocol see https://git.rwth-aachen.de/ModeliChart/ModeliProtocol. + +# Build +Boost and grpc are required for compilation. +The easiest way to obtain the libraries on windows is vcpkg. +The projects are Visual Studio projects one project targets Windows the other one Linux. +Linux installation of the libraries via apt or build from source. \ No newline at end of file