From 0113fcf6d268df693e29e39b6c3ba65e83fde2c2 Mon Sep 17 00:00:00 2001 From: David Baum Date: Sat, 29 Feb 2020 23:22:22 +0100 Subject: [PATCH] explain new features in README --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b43c223..8a83c31 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,29 @@ # Plasma Docker Control -This is a simple plasma applet for KDE Plasma 5 to control docker containers via docker-compose. It is not designed to be a complete user interface for docker, but it provides an convenient way to start (docker-compose up) and stop (docker-compose down) selected images/containers. +This is a simple plasma applet for KDE Plasma 5 to control docker containers via docker-compose. It is not designed to be a complete user interface for docker, but it provides an convenient way to start (docker-compose up) and stop (docker-compose stop) selected containers. -I maid this for my own convenience and it only has i minimal ui. If you have more talent at designing UIs please contribute! Feel free to open an issue if you want more features and I'look if I might find some time. But this project does not aim at being a KDE version of portainer. +I maid this for my own convenience and it only has a minimal ui. Feel free to open an issue if you want more features and I'll have a look if I might find some time. ### Supported Features -* start image (`docker compose -f YAML_FILE up`) -* stop image (`docker compose -f YAML_FILE down`) -* updates automatically if status changed externally +* start docker-compose stack (`docker compose -f YAML_FILE up`) +* start service (`docker compose -f YAML_FILE up SERVICE`) +* stop docker-compose stack (`docker compose -f YAML_FILE stop`) +* stop service (`docker compose -f YAML_FILE stop SERVICE`) +* updates automatically if status changed externally (delay up to 30s) ### Prerequisite Please install docker-compose. Most distributions should provide packages for it. ### Installation + +Run `install.sh` to install the plasmoid using sudo or run the following commands manually. + 1. `mkdir biuld && cd build` 2. ```cmake -DCMAKE_INSTALL_PREFIX=`kf5-config --install-prefix` -DCMAKE_BUILD_TYPE=Release -DKDE_INSTALL_LIBDIR=lib -DKDE_INSTALL_USE_QT_SYS_PATHS=ON ../``` 3. `make` -4. `make install` +4. `sudo make install` +5. `kquitapp5 plasmashell` +6. `kstart5 plasmashell` For Arch Linux there is a package availabe via AUR: https://aur.archlinux.org/packages/plasma5-applets-docker/