README: add readme

This commit is contained in:
Solene Rapenne 2022-10-11 13:35:12 +02:00
parent 8c335981f5
commit b7bcd82d97
1 changed files with 10 additions and 0 deletions

10
README.md Normal file
View File

@ -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`