From b7bcd82d979093ef249f0e5047fa665ace5daa1a Mon Sep 17 00:00:00 2001
From: Solene Rapenne <solene@perso.pw>
Date: Tue, 11 Oct 2022 13:35:12 +0200
Subject: [PATCH] README: add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..51391db
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# About this project
+
+The current project is a fork of https://code.it-zukunft-schule.de/cgit/surf-display in order to make it compatible with OpenBSD and experiment with kiosks.
+
+surf-display is meant to be run as a session manager (run it from `~/.xsession`) and prevent the user to do anything except using `surf` browser.
+
+# Installation
+
+1. `git clone https://tildegit.org/solene/surf-display-openbsd`
+2. edit `~/.xsession` and add `~/surf-display-openbsd/bin/surf-display`