From 15953e9d0db7718685ba2ee6beb07ed57966cb1f Mon Sep 17 00:00:00 2001 From: Rob Greene Date: Sun, 24 Jun 2018 15:38:21 -0500 Subject: [PATCH] Updating 'st' README. #16. --- tools/st/README.md | 82 +++++++++++++++++++------- tools/st/images/western-font-demo.png | Bin 0 -> 7277 bytes 2 files changed, 62 insertions(+), 20 deletions(-) create mode 100644 tools/st/images/western-font-demo.png diff --git a/tools/st/README.md b/tools/st/README.md index 4278408..683d5d3 100644 --- a/tools/st/README.md +++ b/tools/st/README.md @@ -23,35 +23,66 @@ Commands: help Displays help information about the specified command ``` -## Sub-command help +## Sub-command extract ```shell $ st extract --help -Usage: st extract [-h] [--skip-empty] [--stdin] [--stdout] - [--border=] [--format=] - [--shape=] [-o=] [-w=] - [] +Usage: st extract [-hO] [--skip-empty] [--stdin] [--stdout] + [--border=] [--coding=] + [--format=] [-o=] [-w=] + [--shapes=]... [] Extract shapes from shape table Parameters: - [] File to process + [] File to process Options: - --border= - Set border style (none, simple, box) - Default: simple + --border= Set border style (none, simple, box) + Default: simple + --coding= Select source style (bitmap, long, short) + Default: long --format= - Select output format (text, png, gif, jpeg, bmp, wbmp) - Default: text - --shape= Extract specific shape - --skip-empty Skip empty shapes - --stdin Read from stdin - --stdout Write to stdout - -h, --help Show help for subcommand - -o, --output= - Write output to file - -w, --width= Set width (defaults: text=80, image=1024) + Select output format (text, source, png, gif, jpeg, + bmp, wbmp) + Default: text + --shapes= Extract specific shape(s); formats are '1' or '1-4' and + can be combined with a comma + --skip-empty Skip empty shapes + --stdin Read from stdin + --stdout Write to stdout + -h, --help Show help for subcommand + -o, --output= Write output to file + -O, --optimize Optimize vector shapes (source only) + -w, --width= Set width (defaults: text=80, image=1024) +``` + +## Sub-command generate + +```shell +$ st generate --help +Usage: st generate [-h] [--demo-code] [--single] [--stdin] [--stdout] + [--address=
] [--name=] [-o=] + [] + +Generate a shape table from source code + +Parameters: + [] File to process + +Options: + --address=
Address for AppleSingle file + Default: 24576 + --demo-code Generate a ProDOS .po image with Applesoft BASIC code + demoing the shape table + --name= Filename assign in AppleSingle file + Default: SHAPES.BIN + --single Write to AppleSingle file (requires address, defaults to + 0x6000) + --stdin Read from stdin + --stdout Write to stdout + -h, --help Show help for subcommand + -o, --output= Write output to file ``` # Features @@ -141,4 +172,15 @@ File dates info: Backup: 2018-06-20T01:36:59Z Data Fork: Present, 14 bytes Resource Fork: Not present -``` \ No newline at end of file +``` + +## Generate demo disk + +Demonstration of a Beagle Bros font: + +```shell +st --debug extract --format=source --coding=short ~/Downloads/shapes/\]WESTERN.dump --stdout --skip-empty --optimize | + st generate --demo-code -o western.po --stdin +``` + +![Western Font Demo](images/western-font-demo.png "]WESTERN") diff --git a/tools/st/images/western-font-demo.png b/tools/st/images/western-font-demo.png new file mode 100644 index 0000000000000000000000000000000000000000..50ece9d8f64d482b6b854a7e461c77d0724921d2 GIT binary patch literal 7277 zcmeHM`Cn6Kx{uY?RuMbSU=3yKxG)k?5owJOQc%IxTC|d2SY?e8C`wpNLV{OIt(Mga z0){XSDv$-l5FoNSAiK#CF$s$h6(K?r0%Rj(VS@ckm!$Xp0dpt6<0r4--#Z!KR${%s@PGgP_eWm(y#Rr1 zwtjKY%l|xCI_j13{L>AfW7`4R!nV2NrzH8UIRJJ?s4ydA-QlP7&F3jcQhb3^OX zsK7U|A4WCWQNO#q+PL3;)C;LPp8^sRNF>9{^z<|j__O{&r?dh@M3qNC5Ns|gy@0aM zb*%nQ8%uor6Yd%pP}jbBlD$6kbmgqa^ZjBi<~n9EFhktfm4IFj&9RJCAAmp(hjWeV zwwuhA7hJRW3*Ux?F_4X-)EvpB{g|pim$(uuKt-&tK@>txIWzJ8fsx1=TII%eI*w*D z@`k|RT5bS=KF@VnVNB)+%gZO19^FzYbhS~>p0#KdstFMwYt_xV+1s~tsBZn~F6r7h zLhK&fpR-DELTb~5lDS!@vqG=;%8}5zewXS;=Gz^7U?n~gMD*p=#{R$*HSyr>MEXzb$T1S~9;Mox7rBxu%hg%LC{qefEyi_=>+r(H6yT1`Wo_32OkZCgg zZid0cHn;jii zKb>=qQNBWE$72NS>uc+phP;f3eSgCi5a@!#+a*5N!9uXY{^W@fs^d)MM}l#$9KQ94 zp-GB3t!ZGpaHpMDbt5%9DmM^)e>AhQ*UEA_z7Uh-={gB7`&vy`9t$Uqv9~q&W?=SG z6CX2Yglp7?Gc>QQxq*>G!YL~*q>m)*-{e!`769{!yveddrfnNBwTSEW*AQ`9KCEus zzbd@s&OB~y@CZe#wp4GsSAbZ|cIxv)SGJ`MoBj=-yECHJE{QMp6(95kLeHzGqpxl~wm5;aA4|?w1Nyyj- zeDm`09av0>ds4kY3X}W_k)P25J3RX%KDMPkhNrFT#HB6F;oN9~P;6#qsDpS-g@g)J zphSM$;?iC{!8v6aqZfaLtM}+D_}xtm?c<6+bM}QrL(0B)(+1y#>Ft>KLrwz2Oics> zJ5h)pZS^G;#G-E?8nSi8v4Xv2>u2e*A2$m>)9#N+3qvn8iYD9l`>SvRmIV}*LeB=_8fz8GHH_R|6sapQ3p>o4;S}_uE$oKi*w^Z*ihd|P?Wixq5Lau8@mMPzjDAAfc(s@Kj@4Ky(t^j0 z9sIK#A!Ds6t@pNI`WtreD3QLM_pbJ05xDsJ$I~H2O0d#_h`5zQ8zw&cMryeK2Yaq~ z_z$EcWW@_N_h0GsGqb|?f^>f+`ho~#yV0C9Ru7n@{><^-uykt|upTlyFD7ec!D_g~?~I3be)Ez?=K|3a|0T$`Pg zfROpefd{s7s&X!0#7K;L7{Hu4p`K(Rw4oJEV@_QupQWBmpxrZd$S4H+=4EffDoM5T zO$eh2PFm08gwUYnTZ@g`1SE@;$RgWc3H|nd_r6;H)G7HVD{jyrb)#S3X>!EMIwwT| z{U2`Y8PMk~BqY3DmFhcwhTX1iqvQGvY9AIR5L#y!P+Xts;yP%`tv-bV;!_$j5eZY< z!IEh_&ji*OLo!$>eycy4Quq?g> zar_62lvW9Jb>-G^_Xxha4K*G`)8QaMIBSsFF_2iF9AT1L2XfeJb;;%>yL2C6-;N>W zjeN|UdLQk^_Q=Pv#I-^Bk(kO4u`DJ0NCtbzgQqv^ocr8CT3lxIKR~g>b z^LbT@gco+ETwX3c3uAf2T_a1LVj`MnhCuW|DVt9dx(|sx#*6sY ztzFXsv85`lG^YBqiig-;Ii^WFR<(Nj0l(57`kY!fgKFLhp{%&p-{>X|^oSo*wPzm* zWFs3A#Pp71b_P$diS?NMM_7Z%q9sHp z*=)(>*Ub13gA-*avDJpUZ z{fHGhfEQ-U^7>t9P)J>`Jmt*RXqp{ww%zT`+EqScYe*LoHDRp!ALHr- zuZ)m|PY|nLpOM!X@C}n_8-&!N%AKZaKBfr_$d*!PjAS$`bOqbLA|q}T9sdz`XE2+N zXnxwnl3ZaV3cV)=8*+Mq`hs|11fFiVxfsfvbd00~NHoC{akS$`bb+&Q9q5j$V(0O( z)aAT9?D*tUA`d4z#=1G;dF~fGh@5SAl}_O`!6tSQ%FrEGI0T&y-Z} zp|;_67^_CVIyMW6Axm7)Q&-}V9x$15W?oT}%hA9=GzvdDA3ZwA-?91=hRW`)>k&!8S%?MO`cr$;{1r{ zr3#9>jJ|8);Dvi%y*x#GkJvHXB?0cEb-gvw;wfzR8)(m)e|ERsimCn z%6(G^2C^i;ptYk`>CEfw*~CnY1CI;C$EaBYu9I&T@|QwtSznTwX0pchdXPux=>g>PcK0hxUK+{{wmQpUe=KVo;5=@Oz zd~49ig*Qs=?Mb13ZjxSk;Mxpn-Bwn98j#Ig>B6qht`SjS^JC9a9~GE}e%XjX7BfKq zv5Kia>@rZ&?A1kI4DfZF!<u0XAm5ZW?&XI`Wvoo+tK;T=hPgy*n>vF-AqPqc#=?CD&h*2i`j3&O{L+Dm-Vri z2`V)0d5(X)p*m?44GwW!M6|?mMy@tTfq~puwI>eG_XA`x+6L(0%z>`RxR00Uc5N{A zp$XZd#gMqmb(#iYKunu~Tfv{api{ofwC<9Su4FC>`qjg7uxsaYc?&FtGeV!MXHAt6 zw=wY~s?stV(Bvtfq&9rCXR>u3FFqcAbcU@4rk7CBV|${6VQ7xjN#=e;C1)hUfoUSj z3>nzm_i7C-TDnWP6PWp-43fQ-`0}I z*_v6*vrnwoM(~?pqnKfO{Re639GcX;!3%X_B|nVMu&0#LDvd{kiV3*P|BHycDI@VWTd0W|N?iOZDl1a;U5 zjvz^tEJo>hPUY9!B1 zL5Se~zzp;V3J4)s;Xe&Tw%%pFvd@xts~Pu5$SYWXF_y7_!qSaBHS!WR~m{Ky@DiTf7A@&wR{#t?O=;^WG1(#^6XKx z@>>p`sFG!8|Ku`>0&*#H5H+~Y%y!lq!+u0XBO|yPm_tr^6}!c-&hIfQC$?iy)iAvX z*cl~sh}r?ghxsq09?rnvd3LvZ$LV`wCXyS?%6Ajg{X%|Jss6rgYoPO_tqrbjef21g z6L69MW*LTjN{g%}!50=y)3yqBcx4Q)A)sPZMC(O&pS7oauoUkOXAn5B?mWt;^^(h+ zrvpbU1gA_TVF${gv6pS*Z1w6jO=5Q&C0OhZt%NnF5R6?ZFz6b?O1^e0@o^c^SLWGF z)M(_|UGTJ{6K=tu)Wz{$*<^{j7ib(FQq?5YNO&^?64^xmxjmg>bHYwj#Co%_x#VcC zcbWW`6jv8~L`6!g|BvN&+LZBGu18Wlthj_BWy?=@)A+&Bk2Ow$n&N)kh^j6tyGY-B z_O%;hR+kWR0||tSQ*)a92>yj5c4g;~q)D?}7=eFbJd3{~!FYa=zRkT3=G288%F}-g z@}=sC!;!TDTB5N34^;X}&`pHaJ@8Uv*TCI0b$fQ=1SgtPMlvHbCSKaY$h## zcm}2T3!{&9NkAo*svgZ62|^+WFN@Pwn-Ng3ePa`wIn9>wBfJYTZdM9#B~Wfchh9&k^`iF zig0GQ$ronFwW&ZM$n0>UZ4d0Qt{$ehf<-1)QN#p3&eKLl#|Gjfx=#iW`0#3m;j7b( z%X|#T$1E$x^Ow_n+_q^g`&xf!26HB3jsB4HBCIf)UtFWQU|~wGv1F5@sr%n|Nl33y9QVB#(@TA3JSyy9$z2^O^_Y^kQ2lxOtd|jp@H@+kJ3}1@ecVv1;z;wWh3pBG~mb)v> z@7lRTf6&_qFV*sHv6y9{05NONvZG%d`ubp% I_o<8j0zhwi+W-In literal 0 HcmV?d00001