From 6405418f423e734b278511626d55ce95a2e7a9e2 Mon Sep 17 00:00:00 2001
From: Marijn Doeve <marijn@doeve.me>
Date: Tue, 5 Jul 2022 16:08:14 +0200
Subject: [PATCH] Added a Readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9ddee8b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# ProjectorPi
+
+Projector is a personal tool I user to control my _Panasonic PT-RW330_ projector and _Extron IN1604 DTP_ scalar over serial using a Raspberry Pi.
+
+## Build wheels
+
+Building the project can be done using poetry. 
+
+```shell
+$ poetry build
+```
+
+## Install locally
+
+```shell
+$ pip install .
+```
+
+## Usage
+
+Make sure the user is a member of the `dialout` group.
+
+Wake projector and scaler and select input 2:
+
+```shell
+$ projectorpi 2
+```
+
+Put projector and scalar in sleep mode:
+
+```shell
+$ projectorpi --sleep
+```
\ No newline at end of file