Update README.

io7m-com · May 5, 2024 · 81dbf79 · 81dbf79
1 parent a7eb760
commit 81dbf79
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 20 deletions.
diff --git a/README.in b/README.in
@@ -87,6 +87,10 @@ The `overviewFile` parameter specifies an XHTML
 file that will be inserted into the `overview` section of
 the generated site.
 
+The `documentationFile` parameter specifies an XHTML
+file that will be inserted into the `documentation` section of
+the generated site.
+
 The `featuresFile` parameter specifies an XHTML
 file that will be inserted into the `features` section of
 the generated site.
@@ -117,13 +121,3 @@ is optional and defaults to `true`.
 
 The `cssStyles` parameter specifies a list of
 CSS styles that should be imported by the generated site.
-
-The `documentation` parameter specifies documentation.
-It takes a list of `DocumentationItem` values as
-parameters. Each `DocumentationItem` specifies a
-name and a list of `DocumentationFormat` values. Each
-`DocumentationFormat` value specifies a format name
-and a path. The usage example above specifies a single documentation item that
-has three formats: Single-page XHTML placed at `/documentation/index.xhtml`,
-multi-page XHTML placed at `/documentation/index-m.xhtml`,
-and plain text placed at `/documentation/main.txt`.
diff --git a/README.md b/README.md
@@ -102,6 +102,10 @@ The `overviewFile` parameter specifies an XHTML
 file that will be inserted into the `overview` section of
 the generated site.
 
+The `documentationFile` parameter specifies an XHTML
+file that will be inserted into the `documentation` section of
+the generated site.
+
 The `featuresFile` parameter specifies an XHTML
 file that will be inserted into the `features` section of
 the generated site.
@@ -133,13 +137,3 @@ is optional and defaults to `true`.
 The `cssStyles` parameter specifies a list of
 CSS styles that should be imported by the generated site.
 
-The `documentation` parameter specifies documentation.
-It takes a list of `DocumentationItem` values as
-parameters. Each `DocumentationItem` specifies a
-name and a list of `DocumentationFormat` values. Each
-`DocumentationFormat` value specifies a format name
-and a path. The usage example above specifies a single documentation item that
-has three formats: Single-page XHTML placed at `/documentation/index.xhtml`,
-multi-page XHTML placed at `/documentation/index-m.xhtml`,
-and plain text placed at `/documentation/main.txt`.
-