diff --git a/README.md b/README.md new file mode 100644 index 0000000..58c98fc --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +Frappy: the Python SECoP implementaion +====================================== + +Frappy is a Pyhthon-framework for writing SECoP servers (called SECNodes or Nodes) and Clients. +It comes with its own Graphical client and a assortment(word?!) of example Nodes. +It is able to use TCP and Serial connections. + +To get started, look at the provided demo, the provided examples, or have a look at the INTRODUCTION section. + +Main development is done [here](https://forge.frm2.tum.de/review/q/project:secop) and a readonly GitHub-mirror for easier access is available [here](https://github.com/SampleEnvironment/frappy) + +Requirements +------------ + +See `requirements.txt`. + + +Demo +---- + +Use the following command after installing the dependencies: + +``` +$ make frappy-demo +```