diff --git a/README.txt b/README.txt index 7be5ce4..69a55dd 100644 --- a/README.txt +++ b/README.txt @@ -30,16 +30,48 @@ Visiting the base directory will show the user-facing documentation via web brow CONTENTS ======== -app.py - main flask program -install/ - folder containing sample configurations -kjv.db - King James Bible database -index.html - root document help file - user-facing documentation -INSTALL.txt - detailed installation instructions -kjv-api.sh - script that properly runs flask through uwsgi -kjv-api-test.sh - script that properly runs flask through uwsgi on port 1612 and global listening -README.txt - this file - +. +├── app.py - main program +├── data +│   ├── 1828_Webster_KJV.json - Dictionary +│   ├── kjv.aff - KJV Spellchecking Description file (hunspell) +│   ├── kjv.db - KJV sqlite3 database +│   └── kjv.dic - KJV Spellchecking dictionary file (hunspell) +├── favicon.ico +├── html +│   ├── dictionary.html - dictionary search landing page /define +│   ├── find.html - unified search bar landing page /find +│   ├── header.html - navigation bar added programatically to rich results +│   ├── heaven.html - Bible way to heaven, static page /salvation +│   ├── index.html - / landing page with unified search bar +│   ├── reader.html - not yet implemented Bible browser end point +│   ├── reading_plan.html - not yet implemented Bible reading plan generator +│   ├── response.html - Template for rich verse responses +│   ├── search.html - Bible keyword search landing page /search +│   ├── show.html - Bible verse search landing page /show +│   └── votd.html - Matty's test VOTD rich landing page +├── install +│   ├── apache.site.conf.example - example installation configuration +│   └── kjv-api.service - example systemd service file +├── INSTALL.txt - installation instructions +├── js +│   └── collapsible.js - js for the definition drop-down menu used in unified search +├── kjv-api.sh - runs flask app on port 1611 +├── kjv-api-test.sh - runs flask app on port 1612 +├── media +│   └── kjv_background.jpg - Matty's test rich media +├── README.txt - This document +├── styles +│   ├── collapsible.css +│   ├── fonts +│   │   ├── Arizonia-Regular.ttf +│   │   └── Parisienne-Regular.ttf +│   ├── human_readable.css +│   ├── search_rich.css +│   └── votd.css +└── tools + └── av1611_dictionary_scraper.py - builds a dictionary json for the 1828 dictionary AUTHOR ====== -Copyright Tyler R Dinsmoor 2023 +Copyright Tyler R Dinsmoor & Matty Sneederson 2023 diff --git a/favicon.ico b/favicon.ico new file mode 100644 index 0000000..6598aed Binary files /dev/null and b/favicon.ico differ