From 2eec0f639876be8b3b915374d68cc62580903194 Mon Sep 17 00:00:00 2001
From: apio <blobs.trading@gmail.com>
Date: Fri, 7 Oct 2022 16:16:45 +0200
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6870ef6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# Ortie
+A small web app to practice spelling.
+
+## Setup
+`python -m venv venv`
+
+`source venv/bin/activate`
+
+`pip install -r requirements.txt`
+
+## Running
+`gunicorn -b localhost:8000 main:app`
+
+## Changing the defaults
+You can add, remove or change entries in startup.json to configure the words shown. For example, the default entries are in Spanish, but you may wish to change them to English, or to another language.
+
+If you wish to change the language, you should also edit the title of the web page and the starting text in [index.html](templates/index.html).
\ No newline at end of file