licence and readme

2020-03-01 17:42:12 +13:00
parent 2d605c85a2
commit 96497ff89d
2 changed files with 40 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,19 @@
+# Lightdm mobile greeter
+
+A simple log in screen for use on touch screens, designed for use on postmarketOS but should work for others too.
+
+## Installing
+```
+make install
+```
+## Configuring
+/etc/lightdm_mobile_greeter.json
+```json
+{"user":"<YOUR USERNAME HERE>"}
+```
+
+lightdm.conf
+```
+greeter-session=lightdm-mobile-greeter
+user-session=<THE CHOSEN DE TO LAUNCH AFTER SUCCESSFUL LOGIN>
+```