diff --git a/commandlauncher/README.md b/commandlauncher/README.md index 15001422..78a73649 100644 --- a/commandlauncher/README.md +++ b/commandlauncher/README.md @@ -1,26 +1,31 @@ -# Application and script launcher +--- +id: CommandLauncher +title: Application and script launcher +--- This plugin allows you to execute system commands and start bash scripts. -## Application launcher +## Supported Things + +### Application launcher The application launcher allows you to call bash applications or commands with parameters from nymea. Once, the application started, the `running` state will change to `true`, if the application is finished, the `running` state will change to `false`. -### Example +**Example** An example command could be [espeak](http://linux.die.net/man/1/espeak). (`apt-get install espeak`) espeak -v en "Chuck Norris is using nymea" -## Bash script launcher +### Bash script launcher The bashscript launcher allows you to start a bash script (with parameters) from nymea. Once, the script is running, the `running` state will change to `true`, if the application is finished, the `running` state will change to `false`. -### Example +**Example** An example for a very useful script could be a backup scrip like following `backup.sh` script. @@ -57,3 +62,10 @@ To make the script executable use following command: chmod +x backup.sh +## Requirements + +* The package “nymea-plugin-commandlauncher” must be installed. + +## More + +https://ubuntu.com/tutorials/command-line-for-beginners