aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..62abddb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# rt-settings
+
+## About
+rt-settings is a collection of systemd services and scripts that allow to set pre-defined real-time related scheduling settings (using [tuna](https://rt.wiki.kernel.org/index.php/Tuna) for example).
+
+## Requirements
+
+* linux-rt
+* tuna
+
+## Usage
+When starting the systemd service *rt-settings.service*, the general settings file */etc/rt-settings/rt-settings* will be sourced.
+Using *rt-settings@.service* a configuration file (by the name of the word following the *@*) from the */etc/rt-settings/* folder.
+
+## License
+This software and all of its components is licensed under the GPLv3.