Add README.md
This commit is contained in:
parent
e58d098941
commit
2eec0f6398
17
README.md
Normal file
17
README.md
Normal file
@ -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).
|
Loading…
Reference in New Issue
Block a user