From 84f283426ff3dfd5070a1be474428813f3eafcf9 Mon Sep 17 00:00:00 2001
From: David Runge <dave@sleepmap.de>
Date: Wed, 25 Mar 2015 02:22:14 +0100
Subject: README.md: Adding first README, including about, usage and license
 section.

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 README.md

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.
-- 
cgit v1.2.3