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`