Switch README.md and description to English
authorBenjamin Braatz <bb@bbraatz.eu>
Fri, 5 Mar 2021 14:20:44 +0000 (15:20 +0100)
committerBenjamin Braatz <bb@bbraatz.eu>
Fri, 5 Mar 2021 14:37:15 +0000 (15:37 +0100)
README.md
setup.py

index 8b301f3ba35c316079993b3ca1009dad08b2faed..6b47681a601c4c18f0f40c1893594900e74ff812 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,14 +1,17 @@
-# Control-Pi-Infrastruktur
-ControlPi-Systeme sind Raspberry Pis, die Steuerungs-Aufgaben erledigen.
-Sie sind nach dem Prinzip der übergeordneten Steuerung in einem Baum
-organisiert, wobei jeweils höhere ControlPis die jeweils niedrigeren
-organisieren, ohne dass benachbarte Systeme oder weiter oben oder unten in
-der Hierarchie befindliche voneinander wissen müssen.
+# Control-Pi Infrastructure
+ControlPi systems are Raspberry Pis which fulfil industrial control tasks.
+They are organised in a tree according to the principle of superordinate
+control.
+ControlPis on a higher level organise and control ControlPis on a lower
+level without the need for neighbouring systems or systems further up or
+down in the tree to know each other.
 
-Dieses Paket enthält die grundlegende Infrastruktur für ein
-ControlPi-System, die Plugins verwaltet und ihnen ermöglicht über einen Bus
-Nachrichten auszutauschen.
+This distribution package contains the basic infrastructure for a ControlPi
+system, which administrates plugins and facilitates the exchange of
+messages between these plugins through a message bus.
 
-Die Dokumentation kann unter [doc/index.md](doc/index.md) bzw.
-[https://docs.graph-it.com/graphit/controlpi](https://docs.graph-it.com/graphit/controlpi)
-gefunden werden.
+Documentation (in German) can be found at [doc/index.md](doc/index.md) in
+the source repository and at
+[https://docs.graph-it.com/graphit/controlpi](https://docs.graph-it.com/graphit/controlpi).
+Code documentation (in English) including doctests is contained in the
+source files.
index af67d931b737ebdbf2ce9eb01795e397865d52bc..ada53ecf6212f113322371a60ffca941b78b9df5 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -8,7 +8,7 @@ setuptools.setup(
     version="0.1.0",
     author="Graph-IT GmbH",
     author_email="info@graph-it.com",
-    description="Control-Pi-Infrastruktur",
+    description="Control-Pi Infrastructure",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="http://docs.graph-it.com/graphit/controlpi",