frappy/README.md
Markus Zolliker 3a2a90e712 README: add link to doc on forge.frm2.tum.de
Change-Id: I4a183202590a7e73ee1a905538c35af175f6c82d
2023-03-06 08:24:15 +01:00

30 lines
902 B
Markdown

Frappy: Framework for programming secnodes in Python
====================================================
Frappy is a Pyhthon-framework for writing SECoP servers (called SECNodes or Nodes) and Clients.
It comes with its own Graphical client and a collection 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
```
Documentation
-------------
[See here for documentation of Frappy](https://forge.frm2.tum.de/public/doc/frappy/html/)