From owner-freebsd-ports  Fri Mar 29 03:05:16 1996
Return-Path: owner-ports
Received: (from root@localhost)
          by freefall.freebsd.org (8.7.3/8.7.3) id DAA04961
          for ports-outgoing; Fri, 29 Mar 1996 03:05:16 -0800 (PST)
Received: from silvia.HIP.Berkeley.EDU (silvia.HIP.Berkeley.EDU [136.152.64.181])
          by freefall.freebsd.org (8.7.3/8.7.3) with ESMTP id DAA04942
          for <ports@freebsd.org>; Fri, 29 Mar 1996 03:05:06 -0800 (PST)
Received: (from asami@localhost) by silvia.HIP.Berkeley.EDU (8.7.5/8.6.9) id DAA28420; Fri, 29 Mar 1996 03:05:04 -0800 (PST)
Date: Fri, 29 Mar 1996 03:05:04 -0800 (PST)
Message-Id: <199603291105.DAA28420@silvia.HIP.Berkeley.EDU>
To: ports@freebsd.org
Subject: Proposal 6 (aha): README in ports directories
From: asami@cs.berkeley.edu (Satoshi Asami)
Sender: owner-ports@freebsd.org
X-Loop: FreeBSD.org
Precedence: bulk

I hacked up some stuff for generating READMEs in port directories.

You should extract the tarball (which is also in my freefall home dir,
in case you lost the second half of this mail) in /usr/ports.  That
will create a subdirectory "templates".  There is a patch in there
that applies to the -current /usr/share/mk to modify
bsd.port[.subdir].mk.

It doesn't support the toplevel (i.e., /usr/ports) yet (I'm sleepy you
know).  You will need to create files pkg/COMMENT and pkg/DESCR in a
subdirectory (e.g., "games", "x11"), and type "make readmes" in there.
That will create a file "README.html" in that directory as well as all
the individual ports in that category.

Use your web browser of your choice to look at them, I'm only using
relative paths so you should be able to use "file:" and be able to go
up and down (of course, we are eventually going to put them up on our
web site).

I verified that they look ok with at least chimera, lynx and netscape
(in fact, the ".html" suffix is to make chimera happy).  Of course,
the text in the templates are going to have to change a lot (this is
just a framework).

I considered trying to make it as plaintext as possible, limiting the
html tags to the beginning/end of the document, but it just doesn't
make sense to do the subdirectory listing without using full html.  At
least the individual ports' README.html's are quite cat-readable.

Also, I didn't want to include the text from pkg/DESCRs because some
of them are quite huge.  Using html solves this by making it easy for
the user to jump in there (as opposed to, for example, reading the
file with "cat").

Any comments welcome.

Satoshi
-------
begin 644 ports-readme.tar.gz
M'XL(`-N_6S$"`^U:;5/C1A(V^PW]BHX.RA!CR9+\LKB,`]A>EF(-E&V22V43
M$-88*]B2HI%)40OWVZ]G]&ICS%6NUE>7G:=<2)[IGNEY>:9[V@1DZDW,@%`U
M]]4`Y5*M4H$<:'K5,/#)4(J>T1>H8F7-J%7+!H"FE74C!Y7<&C"C@>D#Y$QJ
M3NT5<G^."9GD_G8(DO7O=8[:W<[7Z$,KE:KE\L*Z9]:_4C&2]:]IN!<T73-*
M.2BM<_U]UPURW][Z#\8V!?R8,+)]&L!P%L#(]<%S_0#"+4$5@"//FSQ",";@
MF<%P#($KW5)+85*_*'1V:]G^K\KT?@\\U&=BR;X"VP%U1GV5R:IQ\9XT]`D^
MP;N_4]N=?JL'IF/Q;ZV+;K=S/N!6$!/["ILGP\#U'[E4\.@129Z:]P2P$6M*
MJ,QZP6Y]HDC2:0"62ZB3#U#5XP/A%KG>A#R0">S(B3U4W@4[H&0R@D<2[`%U
MX=&=@30V'Y@"ML-5>5?8@^U8]H-MS<Q)UBB;4.RU6"Q*?3-PZ=B6^%ER.*3*
M+?'OR80\*L2:2?\7_.=+JFA?A_^OG/]&.3G_JV6=\=\H5VMKYO\W>OXWQL%T
MTI0:@1U,2#-B/.?>]O;E16^PO=U0PSJI,4:R-1MC[14Q5H%_F1`TQCXJW+K6
M(SX\'[6E^*1AA(KU[0D!=P1RW(@,.YXYO#?O"#CFE/"*LQ,LWU7F&W`=4IS8
M#@&+T*%O>X'M.MR<@`FQ/5R7)&9$3N`O\%]?*__+I7+*?RWD?ZTD^+\>_B-1
MI<L),6GH33F].#'EA@ECGXP.Y,1)R\WDM:&:39E3SH2)Z]P1/\M%I.OV]O'5
MZ:?V=;MSV3EO][<1O:OS]"OR4^4G`S.AX>$S[DY1XLW(#B>Y"2<NS#S&>>`>
MG'4M/<W)+U,)V,=CYPMW]1#XA'#5AAH=3&IX^`G^,_[SP.ZK]/%&_%^IZ=4D
M_D?FL_C?T&LB_E\'+AR,Z^,0G?I#E8Y-GZC3^SJT?NQ+*ZJ[&!2S<V*5#+LC
MN+>_X\U`LNS1"(K^[*68&M\D4`R4[#<65*^6W_R)6&B)CRX#2D;=J-2U,FC[
M^U6I4"C,-[;YP;>YJ+X/);VNU^K&^U#T\!"*VGYMKPH%]JC!X:$$_]2TXZ-^
MYX>#S4UN`7[O525HG_8'[=,>*][ZPH*6/GY[5BV;!FPRJ+KUA8E<]Z^.684$
MET>MLZ.33G]1(XISJ%08=+J7GXX&+T42;DJ@V"/XSL+Y=HBU<WYQ_5/O#$5V
M)0A?0DVE==7CBG^Z_CWJD`DE?'"&KK/!&;H1#0Z#JNOV<:2H/IB^:MVJ>+1+
M($&G]?&"%]_:CDJ&8U<JM(X&A;AD:`82M"X3B:&'*N<_)O/$M9P'"7K=1,:?
MAG.L5??Y)&LU;:\<6K)YN/6%]?@,10?D)WFAY(9?O:*Y*EK$(XY%GRBNZ-/,
ML?^XR8K+LE10L-X>205\8S.&U+XCP4YT2]R5"M%;?3-\6:V0R->EPN:A/X7B
M"#*SG'$XK)Y;^EIUVLUR"=Y#.)#K;O\$!W-P<-`$:+%;LNW<04:6.UW<)V<G
MYT?=SK,<JN(:/6-ILIF>YR]T\`2?41!W2;_3QJDED*<;<=B]D;^))S$U#S6R
MPN^4[]7/.[_\IO[ZO<K_?M[=VGKW67N7O\EOW.7#UC>3=EG4OI$:F4@T8>MP
MSF"4X),17_N;+R1>&9+^RI`6HHZ-O(R#ZQZ==9[!\VTGB'<1WA]H<"/G-Q9M
MGXM27JHO;,9,"Y'I\UOI99^XK5X6UD.MF.(?.H/6Q]B*77AZ2FKFAL=K6-]Q
M[:?3XZ5:<5FZS3B]\H/XNH2QWQ\SVR<T)AL%.;\@'9(Q:S4N`>,B/D(V9N3S
M,@O`;F?VQ%+R*0&6\VWIS";SM%"^,%69Y9H;\AJF8L&P-V?#GSF9N8#X*<$_
MX$.88L)@9()'/KO-LK@UN@M3EH8R`YA1C+*'IL/R9-<6F9``=0)@/L)7WO+#
MD1O\UW_DB</TUH)#3@K?\LN)X&9_YH0^M\Q][ONZL=P]IQH+7OI]'8/#U$N7
M*GL&.A#VT+G_R.ZBX9@,[^ELBFXQ?JU#Y(FO^IUDPM_T#E%:,:N[?D<1QP'P
MPT&:0,V&"ZQB>;BPVLTPG[[*OW"'@FY^Z=&+Y>3.]1]3CT(Q`HN/3CRQ.R<7
MO9^Y2^']S/F31#3C3):YD=@%A$8D`TESQ<UYB15FZJDL>RK!U,-)YKEE)_`Y
M7]!_1,%:/#GL.$ANE_FM+UQT;B+S<C,OQQ7L4ED'.>PI["&V+-+,YK4S4FRQ
MT10FS@^.L#RU.-I)"VVN&*T1Z?X7^9]T@=>6_]$K:?Y7U_`NJ)4-]ON?R/_\
M;_._*9O?S`%G1?]B'I@U%&\^EOA-FY05Z9O.T:PU_YN>)6OCOV9H"?\K1HWS
MW]`$_]>!54E8D53]EOFOKX__FI'^_L-B`>;_=<'_M?#_(_$)X`7NU9]5:?J?
M&#;N%AK^JP4Z\'BG1+^T"L8+"`@("`@("`@("`@("`@("`@("`@("`@("`@(
8"`@("`@("`@("`@(K`/_!E,2Q9X`4```
`
end