Add initial README

Change-Id: I314b6bf527ba6bb7011804a3768e7785ed4046e3
This commit is contained in:
Alexander Zaft 2023-02-16 11:51:46 +01:00 committed by Markus Zolliker
parent 65480cd773
commit 5c874483a9

25
README.md Normal file
View File

@ -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
```