From 98768d93996a5e930a350db3f8ac363be26c8f09 Mon Sep 17 00:00:00 2001
From: Tyler <tyler@dinsmoor.us>
Date: Wed, 18 Jan 2023 15:26:43 -0800
Subject: [PATCH] update readme, add favicon

---
 README.txt  |  52 ++++++++++++++++++++++++++++++++++++++++++----------
 favicon.ico | Bin 0 -> 15406 bytes
 2 files changed, 42 insertions(+), 10 deletions(-)
 create mode 100644 favicon.ico

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 0000000000000000000000000000000000000000..6598aed5bc37dddb63ce13bc9d607f632265fbca
GIT binary patch
literal 15406
zcmeI3f3#gib;oBUNK6q@{DA`E^G6|7(3mRFvf3h2s#Z{`V6n<d16JGWq7|eT1QLIM
zwZgKdU?PxTB=62S?~#as$j?L@2vmVkLqsBA5L!V9h)6_~q@VAeGv}Op?z#8fD1UW1
zYwb64=ImdyXV0EJbMAA_yPe$Bsg8QYeRz^{2RY|PM&k3d-*s*Qebc8G@Aq?V-HV)?
z1`Z@p#D1#Q;^FGNAm7Qmd?)9|c2e6}n|_s|ip{QvNbU2P&Sk5;%hoy{*3zcVu6HgR
zUs4;{{3*PDC;hX$+g>nQIN7`K-{3z3JPPd=-UHc>(cvuTW<N)AV+ot-zskAJ(crAI
zK0kj7^xvcZ0q2&z2H3~BrTci-*~_`PyA*`zxeQBXKVy8KMb7EaJmLL<$=>JBgBSGT
zJ#Y7}!9r|G+Mjt-pqGB9GR}{K|CrMlkk6PTANu*bM}qtn-iM|1jiJXIi@yD#yB)fd
zfpO%1LbfmE`zXIAZ)e8;9%y986Cw}E(}>0jIeN^W=Y6(;@!ZY0ceB?*ar1YEb_HWy
z0sYEI$6L*{%lF2HFEcdk3*JAW>%VyB-dw>gd%5$=-b~+G#<2k23ym)?k@sBqT}j^>
z=f|*}Y@|677#2O^)j1fPx6xiiy*Rz`4trs5blzOq>q|CI-Y?xP`rd-c(0vfubHF{s
zyV032rNBk=C3_e4iXy{Y@NZyTD}i@|bB}YY3Z9WJ8ctfwn*v|xEBTD+M4rc?{Rn)<
zdH#f`B5(1*9&XtyvF|IrAAK!4!M`?NE?k5S?}GLepaUFb^llphv(tes==(S{k0V>P
zd>#CJSKb{;`>&|)1pW=U3i*GQYzg0^cz*@;HPqKadoA@<@SA1+=T_qXotez%Td?y1
ztgGily*1XNc;*K1ZVqz<_&KznouW810vrZ-Yti^ki<AT8i^&dySsG$QDQJzd*4;(#
z6?^bwFTWcEWB9sk*F{}C#Lk{qQRx<fgn7yHnM2k^Ahu;+pgymFqMa4bdY63?J>Lox
z>s@RUpN0tQmX~XN^((U{!Sgs^Bd`_tMH}F2sh@b6-GqGnQMCO^zCU=U0qY{aaE{rx
z2c7lp!o~RSFTvYhz&7d#K4ZazvR(8)0I&D8^0P6AmFSyzeV29cL1cUzTE*JeOND4L
z{ayY7a4)C-nL@T~a39ZF&n2LP+QidrJ@D_yW?zxdG>f{j^-+HKd)iAPo?@i!6+iB#
z7=0mpiBaJhXc#B^p6k5ZxzRtY1M#kS?z{onF9Fz(YXz|}o^{@W9L5qD|JWacw+Xl&
zKwpbT^e-c(CfemMpx@++4jtBdw|L*`z3>vU2}y*lb;Qi?u<?7z&%Oy9f&4YpvMur#
zAv5um{p0v~hu-7~ZqdG7%oD0QY4=@DMl?$J$sUh#Z2Z?D``hUAVfvn;emd@hg#^DC
zU7GS4zlvlPXjPSZs+Xou*{z288qUEy`fx7trqFkx>Ev_#FctBr=AZY)_zU?7&Fb;j
z;RA=G|Cy|n3mDVk)$1rc{tcf2=cfR6wzaniT;@}AtiH|%BA%$#YRLDpe?z_zgk#}@
zZ;D5Fm>LL|!*4{Ks$#x*2k*{^elNQ0hk(XL3}_blU$_0u{|dB9S32w=f05;*E*pjJ
zJbZ__4(yfnGJog#lX4(*KQQv@;s{zpe%tuFnZ+lcWsK(vWZytd?7EbASCpoR)Zbdm
z{@K^yBl`gPe<u6)vQZD?Cy!))pMd6OXfB~<PV&EPWlv}1Bb%6A8f-7#10GA^!59>S
z!j;VFUdF4$jE(ZqjkCrqU%3fgz6ia1;zPZQCDF+zl;dZA3GbJ6$IXS4(fuR5yB8ed
zy7o8ihi%1tl|4{4GMUt4QNCCHUzDx@@%3HcdlLBU0~Wteaem3~BvfjYWPPwMfLY{;
zuQvS(9&rTHu|tl(^gwVAf)8stXPso<0N7hhml@(&*+@?+I%6o;4aA-7R{(Q;=}Y6g
zgs**M)h^y~_GsBtnCrKb|J{aedndYR$Lw3qEqQU|+u=;nE4^6X$h7r`e}&S&N?tXx
zTC;r3Sjp+bjqo^?IC2!SXYw3){s}d_!#(t$W&}M9Vtirz$Tl6S_|mFxC048|cKII2
z`3iELRBQwAm2fUG_I>ar4uxAQ$~xgN>wD=wbxGJ1|4^QwxS^t)JgK7GUolT-n|`Iz
zx{NP6%QAlKP>mmQnSim}guGR}pGSQ&^0XGUrmsf_bjyAO5bsJQdIZ-c)?fN&e6#(v
z5#MdS>8vE1X4rA;tH^(qb1T@Jv9CA(CU051Z$CLEvv}E!6Xzd(E%To=HGAKP9mp|9
z4`<wYd^3jKvkd^Y7(X~+4_7BGD*uDObm+3b@$#3wlsL95%E|tj8e1rj3LBuo*FvFB
z)BbiRvbXmga<eh;mFF}e5c4#@mRoJ3ZpfFOmmNy~MF8VW`-<|sa1GB-Id}Q<d&jJE
zWM>*UbHUjN+)tbN3lE@gt<L_JcU$QfZ-|tSrE`Ab8orGF+c<yA=dJ@!Yx+&`ylm_2
zcIP|qP1vzsGYMYr0`CXnI{`@ccKk^3Zwwji;c<RAo3JmbXua9^*;BQi$#J}LM$?;|
zbo}=sUi!<K*5%keTuuEL_>8duK0Sw@^X^IDyWpQt?1L~;Y{-<WXztlpvWFSdYU%~p
zgY#JDFxvOwd#_DWtuEu%$|>Oe5%eELhqI{92LEjAKO27%=y^7L0L9L5WEE4efSG{2
z+{@nCEx_l1&jR>E{_$ub$><krgrU7-^(5ytA8V|3s(V0Zwe6+mHjV**Om<YD#Hv5m
z+a<z)Mh|{Z#{lC0r>|JNZaOd%@NR^^&u$ss#C6PiJL=QhGq``4QS{?E4DF8ML|MOv
z#FB(Y*-p~6p3WyP(%yB!t^>h0-|IYh%g%7BxK^zspsWYHDshHyXwMqmlbA%@8a<wv
z^&w*3KM-^JKxp)n=i7NpF^YY&jNg4U=%;+yuQ=Wv-^y1#EEVgN59Kq7yW~SUOXqi@
z&nEN-!X{#`+IPi1wd)`p+bh@6PmI^OQ8{(D{2sAA9m3cBZ~h+meF}I#ZG53$Nh1<Y
z_I5z={!!p*Kzrg2fO12-i(`+seDM(HbUx`{qICUTF_pPKj&YBp?>*2fe^*ZQIB+R_
z<k)?RF;On1JU`rnokh2OVzB+Yz^k`8zxr%B^hd-sR9_5jI&{ticS}RwgXp}9eRUQ6
zThVJ1Im27iJ%7a|*<X22I3L`HfNeEi8Vh#S8Er!N1-MTD_?X?*&WQKLm9%CnO1Hc&
z*-Lvp^QW9jz9hTnC(|e14`JIgnmpojX9WGoi|kui(qF!VF9ofG+kjgmD35P~y;ClF
zB{-kQhw(+_VzoHbBDm0Bd0CoA#>}?|mwh_s86r|#33tV_g1*x!KW!H2pI->hBhV)O
znK!$qI+b{I95!K14Fcty%FW5iyw28*d(fsxdk!B%M$KQpiXY%Nc8{gI1m$q{4U4vo
z5#8F>g4zE<a0>m+pYetKGHiK}v+piii*?X<tMr`OIzuW)tJ%G@R%~=Xb`D17hC(;y
z;PRyZNyt7AkU#w^_4*12T}vj(C{6uy&B0Hh%ej*v{~j(5_OMOtt!{g(xSfBa(k<EF
z?&FW7|4)E*fZ}1{W6d*)n6DV&ea-&E=-;M~c<o5(oQSXdywa`IpS2Y3r~e%4S5dPL
zO@G#8+Z|SAf8wxw%<RwI&hYjxhf_9s2hw;2fA*cQx?6vXnTO*0@1S36do56`5$z4V
z-ostM2z+YxA2a<Y^q+=4QQ_9kaxA@XiJx{pm3_l8z$$V9_CDf_w{zToRO8c`xKUt;
z9bRGjm+=Svz3$4J_BZ4j16#jSiBB(#`~KKr*p1x5zQycbLu_g4%omPDx9?Z_**y#E
zPVX%4$aiii-ftoP&*)~9tg$5OU&fz?|LdD>YsshMZ(oN0waDCr%wHC=9;05)^U=g3
z;#5_VL}JaJ=ra#I&9&C%?bv~Msc)2`m96vJXyfy?Mm`<CcT~KpR?~m#`Y-7df24`*
zuW#%&hDWKT2f2&cjOXwmI$Rv@LMv&N3+w(w_r&?v**B&|4Dr-`uH|AHn{0Asbv~~w
zP;neq{|0T>qkfMOeqX;ih`QvPk*hQRM#e##?>gSj29;QAvCnzw+$`$Ty?Xqv*}G~B
zeA8i&{=>)rN(0@==zb*o4)7^pD|UW}8h!ftVnsc;)n&8-wW)uMKfUX>&bf_GdLIrz
z*ZZ*@I_vix*@FPSrQAT@1!Eb+A>j;HPq2Q6wwb<BjC~YcJFM%cs2@S+zoY$wsK36q
zDb_U#1Bqkl84(?tFM;;zs&qYA{Lj9G4D!2j|6(0>Mp>V)tLD6$s^XSf%G=E6?<@4(
zLj8Uq#Yl~ZF%DDsZJJv+75sfUkG`CG54#6zA;nMjMuz+pxpschx|hFRfd12l*I&%_
z8xi|$j(AAl_rjCdYO#qsSp7DLGSC#V_3{_92OR<J$?*6X^*b2HKC~HEv&e2^Cm`dS
z0B5%FGwNHZ|FQU{G*DVRtA`o*iR7IH?GI@ymOjiJqQ8DCV9y)kIeQ}gl~;5QLx1*`
z01fx6Ugt=CBTC;+>SNGemrv*Y>A=@$b9O85JK@!**r;?*pqyD}Zk_v;tJwa5{sDi~
zxzB!^q4BKdS?8L8_UC&WIQH#vJv6K%&VJtZM{Fa1>Rt;`JLPpt`Iemj1!F%N8tkcg
zY2cPKp}W~^7IxM=o#D8rg>En4jmXgV{O=)K>*>wBpGz(MS45wV63f3O&(ve*+0TRj
zKkO;W-L?T+fJ@?j*&2i4qIuAsxN5iJtlYy{5@M%xwY%wCpu@(EaoRTkePggQ+ri*U
z5A<Kbnw+R~Mi?_|PyScL6Y??Sgr4(AL&L^nub>iv-$~i`o6zaWOXBZ54?*@?0GoyV
zfIE<XGw_mLrp+GHzjmIj=QG-mTkYRuGQqR#ZRewVslSDO@{u#CiNk^OhkYAl-?iKe
z9O<upc$B${r8GtADC=iyKPnmaZLnVc0KNVT_z56Cm7l97j@cSuesrIe-3_3>zC%q^
z3i}g(Sx4}y+kg0crk{Pv{<2}dbPO^0bJ%$?a2_%hH*3D4xDifb4DXsqd)CYdxEF%U
z{?X<CdAtA17worx)!tC*wq`Q?-T<HDz}df&%|7LeSXg!{2I<~faX<woC7;+6|F(A4
z5L)!_cb{Oa%$L7|j_ZI^82d5A+morU#->lwC!YZFjp+R9n9tky$RFX)N7V!m-|ROu
z<FEtzmlE}xGK&|#s`NFzdDicvY(BrhyCd+)S%wqOtq(9p^OIJqwsw|68;ykg>*%jJ
zSbhL{-3Mqb5=RtQ^o?5kiOv)0w?g_>Yj<2a8-a7_jD{jR@R)S2lN9IiVf?=&vo&xa
zdTmB0%>id8J73=$^%tV<9`irt-GhL9im?@Iv`vkY_l`E&?LYWDV!!YH3OW`3qqDR2
z9mPP6L&bEzfj-4Y-3b%#+s=d$J1$;*+ts`&C%al}dshQr)akjbmB;A2w*Bs43%EnZ
zPvxZ=w{m8)?bAH7?}z!o7wNkMklm%b*7A)&Ej}il>$P%towt-5D*x44ApFf>u(fp>
zxT}FDqAbY^YU8)W|JM7EE6CL>Ml0^>HwieDzG>+$Tfgh=%%s*igmKCCy4M?6@F?9s
zg|~r!KD@7^UJq=f@6HL}Ztxxjr|^YR|ExRy*PV9kTy(})?0bcLTW}6M<`6Tnf4Wb~
znGf+EWjtX&d=eYiOX6uhqxEzy_;&%s;qWxEOKW}@cm}+rhwQ1CvWOh{HNCl_<m-2<
zwstETvwL<nbnAGBy=PCNJ}b)SjN=un`o(|UrQ2^XmVhtW#uxn~f1BT`o!<AU<+H?T
z*|VAd*K;}Pr~N&RJD2TPqjr9}h59q-EFY2%PqN1?jAzqi^ZGn!UF+;D9!9?v8u{KZ
zwy)vXcPr*w{|jYjq+P2$-Oj4Y3qF9Ym}~Rb*Moa6fR6bY)Sm>1OZNLl^i69jT$H}g
z)wQnLipTaFEBxQ?1h0WsHefFt26T56Zij}sx3eRArq1!v-qB)ekDbJO;!1u$_4lE{
zSMB_Z{`&o@?wmM(y5)>Zu`NFlc!U_o?;<O0+gn;2`rb3nJlOZy<9WtbbqFUQ4@iBf
zZT){u40$K---Ipp1P6Z2qW`7S|5W9hk?|OSZdz}hwbY6gM*?$zxfP}M<MjKes<*e5
z26(K-@!WW()4JFZ5S{2JD!TKt-}3%Bw&w0a_{uMJ-qD#~dF7BLsV($+yYbj~H6-(h
h_M6b|kf0JdO6(`MUw=tnHipM6Nq*b-tp!>v@PA#;Uy1+#

literal 0
HcmV?d00001