Redrafting
This commit is contained in:
parent
a332847c1b
commit
f77f721361
2 changed files with 15 additions and 11 deletions
10
README.md
10
README.md
|
@ -13,10 +13,10 @@ where it manages a 300,000-line code base.
|
|||
|
||||
Literate programming is a methodology created by Donald Knuth in the late
|
||||
1970s. A literate program, or "web", is written as a narrative intended to
|
||||
be readable by humans as well as by other programs. The human-readable form
|
||||
for Inweb (which is itself a web) is here: [★ inweb](docs/inweb/index.html).
|
||||
be readable by humans as well as by other programs. Inweb is itself written as
|
||||
a web, and its human-readable form is a [companion website to this one](blob/master/docs/index.html).
|
||||
|
||||
For the Inweb manual, see [★ inweb/Preliminaries](docs/inweb/M-iti).
|
||||
For the Inweb manual, see [★ inweb/Preliminaries](blob/master/docs/inweb/M-iti).
|
||||
|
||||
__Disclaimer__. Because this is a private repository (until the next public
|
||||
release of Inform, when it will open), its GitHub pages server cannot be
|
||||
|
@ -118,10 +118,10 @@ programs, such as the [Intest testing tool](https://github.com/ganelson/intest)
|
|||
and the [Inform compiler and related tools](https://github.com/ganelson/inform).
|
||||
|
||||
This library is called "Foundation", and has its own web
|
||||
here: [★ foundation-module](docs/foundation-module/index.html).
|
||||
here: [★ foundation-module](blob/master/docs/foundation-module/index.html).
|
||||
|
||||
A small executable for running unit tests against Foundation is also included:
|
||||
[★ foundation-test](docs/foundation-test/index.html).
|
||||
[★ foundation-test](blob/master/docs/foundation-test/index.html).
|
||||
|
||||
## Testing Inweb
|
||||
|
||||
|
|
|
@ -11,16 +11,20 @@ programs than CWEB, and since 2004 has been the tool used by the
|
|||
[Inform programming language project](https://github.com/ganelson/inform),
|
||||
where it manages a 300,000-line code base.
|
||||
|
||||
{set name: GITHUBPAGESLINK value: blob/master/docs}
|
||||
{set name: WEBICON value: ★}
|
||||
{set name: DOCICON value: ▶}
|
||||
|
||||
Literate programming is a methodology created by Donald Knuth in the late
|
||||
1970s. A literate program, or "web", is written as a narrative intended to
|
||||
be readable by humans as well as by other programs. The human-readable form
|
||||
for Inweb (which is itself a web) is here: [★ inweb](docs/inweb/index.html).
|
||||
be readable by humans as well as by other programs. Inweb is itself written as
|
||||
a web, and its human-readable form is a [companion website to this one]({GITHUBPAGESLINK}/index.html).
|
||||
|
||||
For the Inweb manual, see [★ inweb/Preliminaries](docs/inweb/M-iti).
|
||||
For the Inweb manual, see [{WEBICON} inweb/Preliminaries]({GITHUBPAGESLINK}/inweb/M-iti).
|
||||
|
||||
__Disclaimer__. Because this is a private repository (until the next public
|
||||
release of Inform, when it will open), its GitHub pages server cannot be
|
||||
enabled yet. As a result links marked ★ lead only to raw HTML
|
||||
enabled yet. As a result links marked {WEBICON} lead only to raw HTML
|
||||
source, not to served web pages. They can in the mean time be browsed offline
|
||||
as static HTML files stored in "docs".
|
||||
|
||||
|
@ -118,10 +122,10 @@ programs, such as the [Intest testing tool](https://github.com/ganelson/intest)
|
|||
and the [Inform compiler and related tools](https://github.com/ganelson/inform).
|
||||
|
||||
This library is called "Foundation", and has its own web
|
||||
here: [★ foundation-module](docs/foundation-module/index.html).
|
||||
here: [{WEBICON} foundation-module]({GITHUBPAGESLINK}/foundation-module/index.html).
|
||||
|
||||
A small executable for running unit tests against Foundation is also included:
|
||||
[★ foundation-test](docs/foundation-test/index.html).
|
||||
[{WEBICON} foundation-test]({GITHUBPAGESLINK}/foundation-test/index.html).
|
||||
|
||||
## Testing Inweb
|
||||
|
||||
|
|
Loading…
Reference in a new issue