From e03c788ebb34abb702506d25222d996166d58ae3 Mon Sep 17 00:00:00 2001 From: sspanak Date: Sun, 11 Feb 2024 12:57:45 +0200 Subject: [PATCH] documentation update --- !RAW/get-it-on-github-badge.png | Bin 0 -> 13518 bytes CONTRIBUTING.md | 2 +- README.md | 29 +++++++++++++++++------------ docs/user-manual.md | 4 +--- 4 files changed, 19 insertions(+), 16 deletions(-) create mode 100644 !RAW/get-it-on-github-badge.png diff --git a/!RAW/get-it-on-github-badge.png b/!RAW/get-it-on-github-badge.png new file mode 100644 index 0000000000000000000000000000000000000000..8f0dc741a522d9ef65165489ff7af4d6d4565931 GIT binary patch literal 13518 zcmdUW^;=b2)b2(UrKF@wLQn)L=~6%>q*GE#8kF3$C@77BfTVkqq6bgkeCo8RnLR~V1pI5G7!M~jr z6}nKUn;>h&XtxfC?(tijkyGW(uZ>IVa5<7h$d!+YuT0u`kl_S?d zQz7qB6-TZ|UTQ91fDC>rvD95zDk*8%C$~QM{Tz$S`Z_J);r?E>C(%1{bIE;p_eIaN zO;P!QFl+tS!*Lr7>Hl9|Z!@yxqKPDL@9gY&X|QQ(qwM?%yKmq;@@DYArOZb}^r7nw zaeyTDO`}v5eXJMQ4cK~m6L?sLJWO(GZm0zeysNWag$mNr8cf$1nx6(pZb!w%jYaVD z^IPH7Vn5_5o>Db885)L^kB_#z_|L=hMI*s5fiHkFm3Wu5J z1T2hU!}i>TwkW)Ls_`t?*kRplC%Ay!O6!o=eYH9L&i zOQ^$*sUPutHpRw2ux>}oA80W$rcq^jpB{V?^W=YvPmL8YZ@gSe(0~>Z`R-}UfT_wB zy>Ls8ErwYR-d*CcZ#}oXd>h5Z{oiY7Yp~o#n~0W{gIUhw{k^Gr-+Cb?X3Y1@R%y&~ zY;uv(^76qHJZ9HK7)X$pI){RmmX=9(JYNKsk-*OGZUUFuz-DxzUnFz1Y$S7`VJ(}m z^KwH^TQl;~2>Io?S$k-?Mf&-}2V+wlZbjNEaxMvp`XIvjo2Z1uL>hm8|JlhZr%;)o zz(DH~iSr}O=g*%n_orV)-Op9eQp)QUKec@~*=fgecqt|(#s@PcmGF{!<`d(-M{qn* zuWl*CJZlU0HQ@-5d>c@lX{`PEHfm-@h+)me-Wl&foG^LFrsZ<>ch()S$UN$>IHCGLg*eI>ob%z6m;d zddeT1+`G*t-(#Z6uD*)CtIa4N5L+7(7#P?wR_l5ABUKhBz$Bbd@|)@CqG+oPBg)Le z!gTjf_nIc$rUnDUWvwE^f3x+9%yKK84GLee%D8xWsc}#uZX41MA7XftBHuUUQ2!50 zE)s>p36T8uX3d-uz4+&kD~aUb)mN~$B?9ms)eIaQ970mk{n`3Pyqfzr{g*GH*rIV* zm6OdJ;5??W(MtH7HA;N`z?{Q?$+=&C<<&%mgOiFFd^G14H}`h`#W&;G3~@J9rTZ?6 zC;Tl@&SGmAHNi!J%55s%Ew#@asNcVT7bB1VL6N6EJr{< zz<+ONr$i&4A2PwKfxi!=`0r2LTW}YQj97+9@A%*UQG$)UAvFD7LdtVk^*32rtm9=? zZ@$@0q$wuw7efh^m-Erk(i+>@;oI2QjE;`p6cM3zcX$8U*(s%@bp50JteqQu1_cELhJ`(nlf$Ntfy?@lU%7gf>Gthw4?vrV-ky5`4 zlvQGu6XuYMyoQfYiu#l+3pH)h@$t@la}bH7eMd(J{Fk-);~jN$p|$(Td{_ml*0JqPPxO3A-iswEb`CUs?o)OLNc#Kk5|4pTeQ6M#^jh~ zn}vzVJSnG)2AofMrpMtou(7ezScG2A`%?%zTNVgMq|1cCb6UAfd^7Kik-4)lT%bo! zCm<}W%jrIxqyD%nQAmAlyj;O{s#+6|PINRIxuD5xOJJ~HtnM8yE|uoCwvc#s9v(Hc zyZg|QlaO)K<${UZqN0ksWCqZpVH41RdB#_WBRe;} zpS{1yjFh`=P78V-utQlIn68dyD3E)du2+!O!9EMs><{a0?e0n~w1)MkJ;HTf9ma=F z^higC0;*tZf5eD7BN3J#zUWbTxw;Ge=fFVi8tXaIqQAegLe|!7RjCcWyDH*Q@_cDc z`UM>=y=mgzX3cImlzg7^3>H4swE#)gMQ%9pE#Eim?uOF{F{-JnKT=iw0EdnYmdoVF zTl_SO-sEU;S`mvLnp6$8JkiG@u4{dj=OJVqY_ZBSb>3mFXOE)_3JTDx1r^QEI9Tkb zs&B#8K6?1juhMlr{%A4Qs2KnvSCmzGILoNshrrjkH(5-NM#4wm%*-rse%|CmT-=@O zw8G3R%E|02!v&ppiJm;EnQv)OxYs^5_LN2xt@55Qf!{8ddx=j_u(C;6-9Q7>eUzv(Sg}qsy zeb{PhYMR5S1=zX|p}RNr^o0A~h=UE<)-rX$#ldN+a$4%E_x0t+di8Rlb#A^Tgm0dI zHH5QHXQO<1+0yHHG1jBq_hj$yXqgqs+WLClkdV9G7ySoUUWJC@ z>FDTaP~g>{tmNsGSrP%zb`S^=wJR&u522U)7^bx~e)yj6(npEb1AKf0tW5Zk3vD36 z&cfXM78Sp(j#X(%$(`7XLWA!ei(;02DUPudOiWCj-MG)q%{A}Uvv%edW#QyeEtoGa zY>s`+n%wri_~$k^H@E#F;ngb?G!cFK?{3rXj|)zKC$&ehK7tlXmwbwWiKQWEzaAzq zJzH>-g=N~>Y}UN%_xwDgiK!{2s@1cRLIW1JWLjF<&LJisQj@Mw3QE!Y7XZs0inUv2 zDa2%CTE;?N-rk*y+WpMm__(*MM~hQcax@|q6Fz)ku(h-6w3{d~ZF8J3tn+$WZ~`2r z9}c$T#65%RvdM3EwF`gK%doIu8PY76vvcT{HNbmkmzLUE`x@YFFMj_diemeklw?pf z@=-p+aA#w>*0XBjSB3qQYT9}qAHXMfR9!t3Zo)yN=a#A9hb`ZhGBUqyugLhJxezjBum z-nikvyVPqs+u$dws2J_-zPq#2Q41>#$4E>}th1Kiv=y)G6Sq{szadI9Ly|J9Uzw9O zFJHb?o)W)z?|PDmo6lOg>-zW{bjN7AB`ee3fq{XJ+Sctv>C0Qev5kO^b5KWk)y}^c z7T!p`yWTi3pmt#1-P2RZHJhWSeK;c&9v&{dZUj)J+i%2XofTa8MC^TBT#n{@kJE#7 z9HS!ZXW~SF*O-GKR_Z_Bdbo-TILA5vdEG(9?>}QINrOL-o9AaE3?|R&P1{A__F#ChjF$*hetY`PgNNmzP^iJ$W z!@RY|nBZxJCr`|zh>0*c)r-APU7a_llkklnK--SqA4-5~eGvJj&Cto&xf%A@nJUW# z8ib?vQ)q?y_KYfuqC#}-K;g6P%mWwb#XQRN>o{xo)B=Cd{XkC$hK&oIIb z-eQ6l_p6iRR_=Hky>BR7t)tYos;Y{#M`LqyGora!8aO1XSL~2xa%!soiyTRr!wlWO zll?rN8PCHF26pzfk`W-Jp|Imx=XYB#VHib4^}Tkx1xx@EO)k#=G2XhhICt6^%UM*MSbu(E6VRq4Cr4yuWtEnn z|Ad*9mD=`_rWEZ=clUZuh-p?fVTkE`r_kLIo_y=ZT4 z#@29eQTXfwO}>qcaahCI`93>4`|R>E040Wmghb81gNe}!2YP_tC)IWvGxZUlea|W3 zP`!SNUfA{VzXB6eP;X$cU)5 zhf~TR_4e7yV9qDOmy8JAb8|an+w~kr3%R+uRaRCubafRQk-QZ?hh5>a8u)@EAreN# zm%C-PFgd9oO2sGdKr&4X#l!Rdv(E`O9UYzU;`Z-?50#aI`G&PrZ>|!&4GF=0-kThz z5PL69<2zt34FUvFQ6z@$i=?)bl_mPL&ffAb`%)gFmy+Dfo?h(jIqz*uQNwcy0f_UB zS7c`|=Y+61Onk#{Y-~gTef(H+?+g7_@2BSVi3)8!YRa7>XwKL0@S2fjUHk^T7?DkB z>FLJ-GScNCIaAg&f-h2fDyB8qqJbX9>9$dGoA?JtM8xhFG(*P-0>+S|`58FqUoQY> zQH1L}J&ckGqY4t3MoX=YmPi5LemeQxO&Q=M`1R{c2w}LVUwO0X$B!03=$6^WH$dH8 zqW|M

$%pw&P`T|9z(3*XUz(bP!zi<>`Ul%e`gQ66e2ab4yFwR^p)V=8Y~+Vg)_+ zvVV4T5Z}6Wi;;;*3ZZrQ)ck?x|4ymbw9-?43&ISKP!Fxg@OTkTHA-T9OK)l!^FSd>T4o~5+9 z^tEU>Js>;p$fo`GM#kjMIxmBl0=Kn|_=HaolY^XDv+laneH_6DP4V~wq? zSU`5(=H=Z*)FuG|0ov1ZA=Y`gb47DJj;`BDd`Te=)a&mH(6W?q)@!m0e! zd^r!aQ_XyavGq`H^zGZX`#Pi3#=cstYQ!9@PlUj!4_+N93hC=p*&eqk3IdFv{4x#a zlniM24bYP}{{H=I0v*0-YRVu>w8C~QE!MThb)Cw0ACddp!Q@5gA?dqX`F#^<-79$K z1zpFxOZ^3U0_lSy0HW{~om!9b=^ZaeJ1M(z+c9E#uPqGm^CMGN6-LHLTJfRm47d#@ zW@c%JW2mN~m4heB$|HJ)KtcIMZWBRK!{d&voWv~9(te{m5`8EQ3G(w<+h>k zs)qDTO%gO3z3lxoB^WDzgoRX$A|*t~=}&PwF%c1FQT(&U*H=6UK8DtEl}v*0UgeV@ zCntaMSv)Bz8j+cCJW!*dv?5xY$NW&5S`{|XfcKNL^ew)!BFghiCg6V))amB2hlj`T zitGN)&VXk!I5&?!i+hh+fzRL`X&;eWoBv@8G@YRk)39e34PXf3;CMNpDNnlU->3m-)~;$SMMt|S9r5% z2e0?s?*B<&ytQa;LvEdE5MC`tzW+4uPVB#<_i2cbIJb<%;01ZjQfc-+zS?yi2cGWD zZ(1_4w?Hk2R}N?e>}kM3LDAFG*De8T+@zYY2mOc0WN@1P^N>KhJOXJ4vQwh+zZ(Vw ze*bVsQ9)sWH0~mf%lMMgXYqo=c8%4cymwGfOpJ_8W)qpd7w231`vK51Ma9JWD_@%4 zw;s&yV72`U5-~YBysPWUm&{DYJ9n_*q*prsB?baF_7_?5cJ&u8iXZMI2{_P!$2Qu4 znxCI9wx1G4_{*j{m{Aj7E^%sWYeNg5f)#oIluxzDP^@6*<%<`u;HJmF+39W6o}GDt zBQ%SsP&8T)E-{K76o~hPp-oaQ(wVBk$=KNV6PNL8_KuISvG1U6SNVFsTJ$ynu-9%8 z0iTssR(_Y1lw`Oo=6!M>7LM)o1Qvo8SXLY8-O##F4HFZ_;X;FuqPmk{+HGuHGWNbo z<;;u>@ zC&tGMjq|c8(Q=W@K;*ByvR3x<^J^kB^xoHeI;d=Kb-c6a;jjv%%NPoOLiqIPDDcNS z0$icWmkV!SI60Xbof%OHJ7*8u{aszX8{&9$d^|L|>jWM~!MGXl&b1jnuAw3$Be2Xs z_6rFK{rXL@u$3djclq+=WwG8e@FVtqDcersc>UWSA(UL^>lJocNr4?K&EG_L#^|Wd zSXb#xjk{B2b+vW*=GpNsVstb$NnT@6QBipXZNlVWZH#4tzPz>@7ez)!##czgw|KTZ zkPIgrFCVy>N3YYwH#^(WEVyMX=#cx#MUye+jxH{b0DsBu>07=x&n}COib~%`7rlQ^ zX!iWM$=`tt5XPQI@1_R^h|kZ@bxKUGsHv${`jbH2n~-P}r1`a1hbf z@}W9!&qQGt`IvR%=i&@lL0{WioN^oP#e}UGekDP(< zAtEJhd0Ws7#cXXmyZHBS5G-%{)347XE?$^l!2|zkxt#2lB zUWW(^3kwNYvj$_~0F@f&y*Syk0unS_*^mbp0MqCd9C_Ob!>9%u*hZ>|XyEvb0~rcq z?LputQ7%R7gTXRZY+dQ|ui9|e$<3|kK-dnD7~HC8yM)+}A8&&DP++H5Zk@5;+yr8s zcT}EGTH3J{TO;pTphV=!_1o6DHY0_9|21McIBZ%cd|&#dED`-r-z2{4c~Pf&8e(xy zeHQ@2LtcLPcQA(pyZ}C7B^ep4p3f4!1juUgkbe92&7*f0%GY+(+Bz#2>lL;9g9oT- z??Z#JiYk^0N|%4C1F-+)6?RkAd|;8>7k^85$===`>SXC^aG;rA1y$ZNQ`7WA(JE<` z{c`m;Sopaa_n`Buc%rIvE*n<&C2dE}QcG3l|=WA7QfR?E>4DFRE$(%`D%8&RYSq@f7JH!5{0Gft8%gk>qNZ1$vW?Zq(nGF{R?>9_ulzw@0Ul_jl9YSBTs!VvX`^| z?6tO$_t4D>qX-(IwEdwx@Ga({rHw2*K_R?8oc8RsTzXYO6(ptUVF(|-1N549)9$tO1bn{Y|po#p(WuHJO5>4W5e03zo?V(+YF`Ty>EyciFlis zoCW2U{jc%!-o|j~#XHaPf#^&kuRjO-aBJ=zeaDHYH^c_$g)o6!eXE?Cu`&Opbp-^Hk4exv%l&G1YFcHekZ=DH%Dr>CW$V z7MC9T>6##c87~rtx?>i71B1EWzx{#rzuZw{OnbZ)tW65~6&^n$;}$6WvC3$!!5VEa z+qmVAPY*YXe*M4zQuEl+u~g32o|u@J!WsN6DKajkZe(%O6 z=q^vsQ~8Q^aHHX@6#T2PIw6#mlMCt(&sr@RT%4Qp`@r-#4J@{;!$WPGG#k0d7xT^7 zw$LzAQ&Z38S$^G;8?b^P#nLhxrLvw=S*f$Er==CczQWS>`|sa7cnmBot(Gp89{ah& zi;03S)7lgBz_2b@seCafS-x|)yGsJ(>YE^XD}}2JRF0O;TOuYI%cQLO`ugc{-B?F3 zC<~fI0aWrdefsRHY6iE zA~o^qAVmY17SA=ly!)2?|k2uultMe2wscsAQ-yS=91Hrmdz0=SRE@_%>jwsh$` zXxC)849fh;AAPG+Lg_rM0yeLynHhS(NKhow5p-g?HENnk+8frF?Aqc_j*sJ-w{xqT zNa^V#z<<@^Jg%y)MqD^B6KQ0^Y1*SHft1}lKUw9hy=sWs>bP6PwUyfdk74`X%hc2~ zOzj-Z9!s%8FvS!=3lu~z{aY=nZw1%n2;*k@*52NI**d@@L8m`>CkN{xA>^E;sX>0R z{IFkK)`Pcemqa}FENd>#PmfMF>&Jdx@S?Y#z42y97IJF6?E>AaWcU=6`?uj_PkQ># zRN7hOhG-0sStAODZ!1@%-p;M81cPE?xOuZ7dx0{@Pdm&wTVfPg*(W|5vgh6LEi&hy zfksm^8!=o?OG^t?d&i;}Z&|wu&0!SV`n~(^pAsVLI|2d%$e}>I0O~h%Kiq2u!H+gC zcG<~%64w;Bc44vHmwN5mH7?m{5Ct-Nt9{+widl}ts@+I?I-9xpM^F8l?#Eq2Yd}Y- zETyEqWCz&25+Gtpv9USW;3eAi&5r4S&rm+Cov>{H`#*4JG_MPChhq2L=RO#OR#qF6 zRY%~wS+9>On#^XDLyM(k-n#S(OuT1M#z*I;n>Kc*g?be|Dca{?3OSTj3knHY)fQ#) zt^(PbN(r%4P89s$NB-fut*tGW%`kgcl1OaWLlinsmEX5=B>!ppFWaR|Teub)hzov< z@5`6muA9?#WhXkiy4G+V0$oet?Tk#kBnef!<8UUpiB#Y!RL*~#6ciM|TuTLzEzdQ$ zicjSaouoCTP0;78Qg!u1#-S$^Bn_F7ufGrV_ySX_zNdbB7 z&r+rb_uz5X**iSS*MRdS$kAcpw;MO>YrsY6>+8P&{rV*SKDOtQ`G>#ti{T8_5c=)-gcT!ztkvZ|`81?OJ05Hn{pb+wbh?XoAkX z4NQPRT>Ly|LTtB-ceKlq|7Z`@j86jw^3qm3y5-vIHCbN&C zxrTA}Z~`tN;TE_A=Edc>VRm3iA*uiikK$RG>G{?V0+}KUW8+k<)2BK*TbMFt%oaU~ z50#X{$0tD1EI|Aq15w0q+wT?3<_3k%hCHx_*4KHV8Pm~)i+LVc@&#E$u_$f<7B4gf z;8O5D4{a}x1$+SY_zL(hyFv90u;64wT)|5R$05wn!mj>Pxxvhbz)(OrYT>Y71Fov> zpeFMS0OG-nRhq4i)Xl!~`|uF-(96#nwY? z&g`2qS@C4icS1&|r<3V<7%3-;jo%EP@`JO9 zFH56e6o!~|K#er*mo_%8gT4pXOTvqTmzM;r`yZv|oyE_)scMe@Bv8>#jEzx(HgE2V z--Mw?C5mJ>h-LrT~aY5pA@Xe-?w@VCaf`NeDF8_9nLHiR7?*j#IbX5 z^ruQ)4W$txzBoUuN9>h1gJK*U_{g7#XlU3wIU~=`&aAx|?{jb{u6lzHT-bjA)w}TS z!_S{(|6ZDzn*L~IGTa`}GBaZaCi8CTvu|C89S1vmu~|Fu(aDJxI>Zr}ge8z==-3$* zJBm=z&}gx8JVB0#pKVEb0VORJ6#!e)R}jO*1tRjy;ZyO`wXakc7|X*2)badwx_@0k zd}!nqMS5+|;U4$7223Uf2^KUS@;x8E8O<;U;oBe$6xY?a7Mhz<% z5D^j4vp8OE6WcfvqhD%<4Xx`MoSUafQ6E3vcyo`c;JV_7-ry~0#>>mgYz`JK;8;VS zO_q&pZU`xB)e94reez@woz&R)=IR0*o}#VV5kpVK^c=S2=PkjcGC3DJi=F0fO3AJY zBcGhB=7%8D^eGOsww%?RV3mV-#A6$2{59xFk1Xjt8)@M0uGY>9XKL>+p0G$4UL(E<~2=%Y3q*>pn3}q7CiEyt_k4$al^6d zrkd))GXilOu<3pBH%qvi#A&txBYnsqLv0R%?@~d6M~@z%*ULxDRAazsNTRc)5JhuI z=t%Qi7Y3IiYsd#0sc0Nrksi$L%x&9N@ShO~x$ETs+*_yAEU5MCBxau#2e;iB^xIOw ztMooc4EGFcZYPMRcDhrDxUx%VNb_W_?|>)(GC`*p$Ma}`_3xjqxZS}+kh6hx-ly~6 z{8=w*YH7U%K6D0PCsS~kp%9x}yPlq&o@ZC8A$8dhsBgYwxF91>ZG*x@i7_lbTZ#r7 zxBHG+SfQFb8a>-WZsfIc3Z)EY$|DsO!n&h*Tx7a{l9Ceqb#a7l($ac+jB{IN?{396Oik9{u=ea}?-O$A#O#HsFErVRNUZq8UN5M@R6 zWx%{2B+HzIBLeQ<^I1(fE`;T{ z@C^7`6WCM$e%G&FeaBX@*_Vn59@y4;#f-^fM>N9zYna@a!W1F4kc2++K0e-BZOJG{ zW4`|4ALsL~PpPqI;L;f{4}4&7umQy`4@@8-sA* zCYqm?AXYC>zo9~Tz~qK*6=0sZh_L2zsexP5znC;s2VIF6w&(Jh^_J;`DrpbU!6yf1q3Q^J`;mND$2*?l=2#eO5KY@>ZAXwg>uxUDG)cP*nZDC zXj7%hPVYlQ-mHeL^(2WvMD_0BFj@W`KW!_kJAb+pv`t?ZUIhu5vrGDRd~Iv)hwWuC z1w}>k&-Y)$<-ZaI`f0lW*wcZa`ZB`0mureDufr@t;}jcAgNxlrAaRCraB!#MhmciBtK-&6R4!FlW`h`LZ$0Ib(8v6Tn!Am zsi|qS3NNL&m=H!I>HfR5eqfA<%7fl+mGlmxyBm_vfJj=76w=l~_^Ins$Ejb5^7ZwV zmXYbGPOQG?{>7oay&ZwYhdYG@6;v3{hV!5PY;T_5yU1B!PXZQ6-9C$m@pd5 zZU7R9ZQ2_85WKrBFs--DFcHHT@t45R(8?;`-MaMq6BV!~%GfZTct%_$Wz zcLq&@`*|0|o0$$$$!7pl%ac{SFpg$B$e##9t{#UQc3VERF#q}_Sv1bbzPX`u5SdcA zckkXOaqnu~yzy0GnJ3gMhB-mdC9_r2`(S_ranwbtlmU7gLGR6h@dYBGX&J*!ON$Jg zKR$R*oQ zZqZ98dN}C>(`~omfWLzh?v#}4%Yi*{U z9*7nx+-);Sb}BgY$Xo=NyORIqV7`!3fdx@)Gjb2!X|y`KH03r^uyv+=a20IuzW^FT z3S!Wkxk0DT!0CnL(@E^$u5cGf) zFH|jDE{estHIx$Q&rr^!cAYpYXsrd145@;e? zpDrHLd;4>nwrY4hQn}`b5G3ef9Ea0CKQM7y4KTwf<_~D26ZKDz4kjE*Oj?3NvZ;9tNRMDpUvpr=XiLU`D0wTRTijKyw25_6pLc1?XwQVuNbGKp9;}_5nb1 zZgKGnOm0AYsa}Z`rgd>`4Np%`Z**efM^_h~ zd*#R=Wf%XAYcrvMTUO|ccdq8c4nyjrb6Gs zcmQ@`t~n(Qe1=C1a(1612Zm-+p%~Q|)i4;nzk(_*EqxskLEs5_Fp*{s91?=_J7W_Q zGiI|HECG^4S011qAW?1Z^;_u&IZb*7vL4n~(A?_vUiHPp#U62MTz)4Ul zZ2m_YJ?7E-`uH#%@cB|DHVRZFg46$Jviv@%2?!w%8-2Cmxmeq)YH+FqvYF+iP-i#~ zUakz@0jCyzS>TlzOjBjYtimMV!NwFW7-XnQT@8)jt7~hCOiMhSKCWso;a`iYyZj2E z-URBuxVZS41DM#kEpSX=?&;v_L+w=g460j)DV@xhI8l%ydlNL!p(wbXp&v<`{{r77G zBS^9GC^f(u(jR25nO~iBiV?FnFl4(f^->} z--X}3kja6)W$76jB1K%D)(Cn6NZB6G2xq9}v;uR|H=i|UhIO|GLirhk0yCxO%?ON` zzWCEc34^NhKrjI){g~y}YT+_GTFAu4=xB;+x{T#eE~&8V+BIe6URD7G2(LoGw5m9qXMq63I_@qvff$<{9 literal 0 HcmV?d00001 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2039e9cb..57e45265 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ If you would like to contribute to the project by fixing a bug, adding a new lan ## Building -The recommended way of building is using Android Studio. As the of time of writing this, the current version is: Android Studio Dolphin | 2021.3.1. +The recommended way of building is using Android Studio. As the of time of writing this, the current version is: Android Studio Hedgehog | 2023.1.1. ### Building a Debug .apk If you have not configured Android Studio yet, follow [the official manual](https://developer.android.com/training/basics/firstapp), then follow the simple steps below to get the project running. diff --git a/README.md b/README.md index 6ac9a589..5d4e52fb 100644 --- a/README.md +++ b/README.md @@ -3,17 +3,20 @@ TT9 is an IME (Input Method Editor) for Android devices with a hardware keypad. This is a modernized version of the [original project](https://github.com/Clam-/TraditionalT9) by Clam-. +## 📦 Install + +[Get it on GitHub](https://github.com/sspanak/tt9/releases/latest) [Get it on IzzyOnDroid](https://apt.izzysoft.de/fdroid/index/apk/io.github.sspanak.tt9) + alt="Get it on IzzyOnDroid" + height="80">](https://apt.izzysoft.de/fdroid/index/apk/io.github.sspanak.tt9) -or get the APK from the [Releases Section](https://github.com/sspanak/tt9/releases/latest). - -## Screenshots +## 📷 Screenshots -## System Requirements +## ⚙️ System Requirements - Android 4.4 or higher. _(Tested and confirmed on Android 6.0, 10 and 11)_ - A hardware keypad or a keyboard. For touchscreen-only devices, an on-screen keypad can be enabled in the Settings. - Minimum 50 Mb of storage space. Extra space is needed for language dictionaries in Predictive Mode. @@ -24,17 +27,17 @@ or get the APK from the [Releases Section](https://github.com/sspanak/tt9/releas _Storage usage depends on the word roots count, and the average word length in each language. Some languages will require more space, even if they have less words than others._ -### Compatibility +### ⚠️ Compatibility If you own a phone with Android 2.2 up to 4.4, please refer to the original version of Traditional T9 from 2016. TT9 may not work well on Kyocera phones, some Sonim phones and some other devices that run highly customized Android versions, where all apps are integrated and intended to work with the respective native keyboard. You may experience missing functionality or unexpected text/numbers appearing when you try to type. -## How to Use Traditional T9? +## 🤔 How to Use Traditional T9? Before using Traditional T9 for the first time you would need to load a dictionary and configure it. After that, you could start typing right away in one of the three modes: Predictive, ABC or Numeric (123). And even if you have mastered the keypad back in the days, you would still find the Predictive mode now provides powerful and smart new ways of typing with even less key presses. So make sure to read the initial setup and the hotkey tips in the [user manual](docs/user-manual.md). -## Contributing to the Project +## ⌨ Contributing As with many other open-source projects, this one is also maintained by its author in his free time. Any help in making Traditional T9 better will be highly appreciated. Here is how: - Add [a new language](CONTRIBUTING.md#adding-a-new-language), [new UI translations](CONTRIBUTING.md#translating-the-ui) or simply fix a spelling mistake. The process is very simple and even with minimum technical knowledge, your skills as a native speaker will be of great use. Or, if you are not tech-savvy, just [open a new issue](https://github.com/sspanak/tt9/issues) and put the correct translations or words there. Correcting misspelled words or adding new ones is the best you can do to help. Processing millions of words in multiple languages is a very difficult task for a single person. - [Report bugs](https://github.com/sspanak/tt9/issues) or other unusual behavior on different phones. Currently, the only testing and development devices are: Qin F21 Pro+ / Android 11; Energizer H620SEU / Android 10; Vodaphone VFD 500 / Android 6.0. But Android behaviour and appearance varies a lot across the millions of devices available out there. @@ -42,16 +45,18 @@ As with many other open-source projects, this one is also maintained by its auth Your PRs are welcome! -## Supporting the Project +## 👍 Support If you like Traditional T9, buy me a beer. Donations are currently accepted on [buymeacoffee.com](https://www.buymeacoffee.com/sspanak). -## License +Or if you just want to show your appreciation, give the project a star. Higher ranked projects on GitHub have the opportunity to use development tools for free, and apply for funding easier. + +## 🕮 License - The source code, the logo image and the icons are licensed under the conditions described in [LICENSE.txt](LICENSE.txt). - The dictionaries are licensed under the licenses provided in the [respective readme files](docs/dictionaries), where applicable. Detailed information about the dictionaries is also available there. - [Silver foil photo created by rawpixel.com - www.freepik.com](https://www.freepik.com/photos/silver-foil) - "Negotiate" and "Vibrocentric" fonts are under [The Fontspring Desktop/Ebook Font End User License](docs/desktop-ebook-EULA-1.8.txt). -## Privacy Policy and Philosophy +## 💪 Privacy Policy and Philosophy - No ads. - No spying, no tracking, no telemetry or reports. No nothing! - No network connectivity. diff --git a/docs/user-manual.md b/docs/user-manual.md index 2d71f5a9..9b407f36 100644 --- a/docs/user-manual.md +++ b/docs/user-manual.md @@ -1,7 +1,5 @@ # Traditional T9 -TT9 is an IME (Input Method Editor) for Android devices with a hardware keypad. It supports multiple languages and predictive text typing, and an on-screen numpad for touchscreen devices. - -All source code, documentation and the privacy policy are available on Github: [https://github.com/sspanak/tt9](https://github.com/sspanak/tt9). +This manual explains how to configure and use TT9 in different scenarios. If you are looking for download or installation instructions, please refer to the README on Github: [https://github.com/sspanak/tt9](https://github.com/sspanak/tt9). All source code, the privacy policy, a development guide and additional documentation are also available there. ## Initial Setup After installing, in order to use Traditional T9, you need to enable it as an Android keyboard. To do so, click on the launcher icon. If you need to take any action, all options besides Initial Setup would be disabled and there would be a label saying TT9 is disabled. Go to Initial Setup and enable it.