From ebf63723277120cee0eb88bc454cc6ee7f98d6da Mon Sep 17 00:00:00 2001
From: Johannes Mey <johannes.mey@tu-dresden.de>
Date: Wed, 29 Apr 2020 08:48:01 +0000
Subject: [PATCH] Update README.md

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/README.md b/README.md
index ea9746f..570fb99 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 # Realtime Kernel for Ubuntu 18.4
 
+⚠ this repository uses git-lfs. when cloning, make sure LFS is installed locally.
+
 These are deb packages built for Ubuntu Bionic.
 
 Used Kernel sources:
@@ -9,3 +11,28 @@ Used Kernel sources:
 Kernel config:
 - Preemption Model: Fully Preemptible Kernel (RT)
 
+## Installation
+
+- simply install the packages using `dpkg -i`
+
+## Verifying that the Realtime Kernel is Running
+
+- reboot after kernel installation, selecting the new kernel in Grub
+- run `uname -a`, the result should contains `PREEMPT RT`
+
+## Set User Permissions
+
+- add a group named realtime and add the user controlling your robot to this group:
+    ```
+    sudo addgroup realtime
+    sudo usermod -a -G realtime $(whoami)
+    ```
+- add the following limits to the realtime group in /etc/security/limits.conf:
+    ```
+    @realtime soft rtprio 99
+    @realtime soft priority 99
+    @realtime soft memlock 102400
+    @realtime hard rtprio 99
+    @realtime hard priority 99
+    @realtime hard memlock 102400
+    ```
-- 
GitLab