mirror of
https://git.FreeBSD.org/ports.git
synced 2024-11-05 22:43:24 +00:00
24 lines
1.1 KiB
Plaintext
24 lines
1.1 KiB
Plaintext
|
INTRODUCTION --- WHAT IS NOWEB, ANYWAY?
|
||
|
|
|
||
|
|
noweb is a literate-programming tool like FunnelWEB or nuweb, only
|
||
|
|
simpler. A noweb file contains program source code interleaved with
|
||
|
|
documentation. When noweb is invoked, it writes the program source
|
||
|
|
code to the output files mentioned in the noweb file, and it writes
|
||
|
|
a TeX file for typeset documentation.
|
||
|
|
|
||
|
|
noweb is designed to meet the needs of literate programmers while
|
||
|
|
remaining as simple as possible. Its primary advantages are
|
||
|
|
simplicity, extensibility, and language-independence. noweb works
|
||
|
|
``out of the box'' with any programming language, and supports TeX,
|
||
|
|
latex, and HTML (Mosaic) back ends. A back end to support full
|
||
|
|
hypertext or indexing takes about 250 lines; a simpler one can be
|
||
|
|
written in 40 lines of awk. The primary sacrifice relative to WEB
|
||
|
|
is that code is not prettyprinted.
|
||
|
|
|
||
|
|
If you're brand new to literate programming, check out the FAQ for
|
||
|
|
the USENET newsgroup comp.programming.literate. There are also some
|
||
|
|
resources available through the noweb home page:
|
||
|
|
ftp://bellcore.com/pub/norman/www/noweb/intro.html
|
||
|
|
|
||
|
|
This is version 2.7a.
|