Переглянути джерело

Updated description, install, and run information

allens 1 день тому
батько
коміт
d40d19776d
1 змінених файлів з 13 додано та 2 видалено
  1. 13 2
      README.md

+ 13 - 2
README.md

@@ -1,7 +1,18 @@
 # Checklist
-
 A web based app to add and check items off a list, which outputs a page that can be set up as a browser source in OBS.
+I've included "ListBackground.png" as an opaque background for your list, in OBS, but use whatever you'd like.
+
+## Setup
+Create your venv, we'll call it ".venv", and activate it.
+
+``` pip install --upgrade pip
+    pip install .
+```
+
 
 ## Run with:
  
-```.venv/bin/python -m gunicorn -b 0.0.0.0:8043 -w 1 'app:app'
+```.venv/bin/python -m gunicorn -b 0.0.0.0:<port number> -w 1 'app:app'
+```
+
+Of course, is you prefer to run you flask apps with something else, go for it.