From dc9ab1d93cc094744aae8b4799ec19b379d84751 Mon Sep 17 00:00:00 2001 From: Benjamin Braatz Date: Wed, 1 Feb 2023 11:56:15 +0100 Subject: [PATCH] Started documentation. --- README.md | 16 ++-------------- boot/config.txt | 5 ----- doc/index.md | 8 +++++--- 3 files changed, 7 insertions(+), 22 deletions(-) delete mode 100755 boot/config.txt diff --git a/README.md b/README.md index f79dd76..a359bda 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,11 @@ # ControlPi Plugin for UniPis This distribution package contains a plugin for the [ControlPi system](https://docs.graph-it.com/graphit/controlpi), that -<…> +provides the inputs and outputs of an +[UniPi](https://www.unipi.technology/) Neuron device as ControlPi clients. 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-unipi/](https://docs.graph-it.com/graphit/controlpi-unipi/). Code documentation (in English) including doctests is contained in the source files. -An API documentation generated by pdoc3 can be found at -[doc/controlpi_plugins/index.html](doc/controlpi_plugins/index.html) in the source -repository and at -[https://docs.graph-it.com/graphit/controlpi-unipi/controlpi_plugins/](https://docs.graph-it.com/graphit/controlpi-unipi/controlpi_plugins/). - - -Necessary preparations: -* `make` and `sudo make install` unipi-kernel. -* In unipi-kernel/device_tree: -** `dtc -O dtb -@ -o neuron-spi.dtbo neuron-spi-new-overlay.dts` -** `cp neuron-spi.dtbo /boot/overlays` -* Copy configuration files from `boot/` and `etc/` in the repository to - filesystem. diff --git a/boot/config.txt b/boot/config.txt deleted file mode 100755 index 7cc1b06..0000000 --- a/boot/config.txt +++ /dev/null @@ -1,5 +0,0 @@ -dtparam=i2c=on -dtoverlay=i2c-rtc,mcp7941x -dtoverlay=neuron-spi - -initramfs initramfs-linux.img followkernel diff --git a/doc/index.md b/doc/index.md index 0913b50..0a61707 100644 --- a/doc/index.md +++ b/doc/index.md @@ -1,8 +1,10 @@ -# ControlPi-Plugin für <…> -Dieses Paket enthält ein Plugin für das ControlPi-System, mit dem <…> +# ControlPi-Plugin für UniPis +Dieses Paket enthält ein Plugin für das ControlPi-System, mit dem +Neuron-Controller des Herstellers [UniPi](https://www.unipi.technology/) +mit dem ControlPi-System betrieben werden können. ## Benutzung -… +Damit die q ## Installation Eine ausführliche Dokumentation ist in der Dokumentation der -- 2.34.1