diff options
author | Bruce A. Mah <bmah@FreeBSD.org> | 2006-11-11 20:15:30 +0000 |
---|---|---|
committer | Bruce A. Mah <bmah@FreeBSD.org> | 2006-11-11 20:15:30 +0000 |
commit | 40e4d6e0cb22c7e8bec79abfe5373fb558c1ded6 (patch) | |
tree | 2e5fc5b3d57bd28b233c2edafeed8e23e2d17e8d | |
parent | 90e5fd03d4caba8ba9f1dc5c282025cef7cfea7b (diff) | |
download | doc-40e4d6e0cb22c7e8bec79abfe5373fb558c1ded6.tar.gz doc-40e4d6e0cb22c7e8bec79abfe5373fb558c1ded6.zip |
Update README to correspond to new file layout.
Notes
Notes:
svn path=/head/; revision=29056
-rw-r--r-- | release/texts/README | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/release/texts/README b/release/texts/README index a36f0b367b..b15f96a5d6 100644 --- a/release/texts/README +++ b/release/texts/README @@ -2,14 +2,17 @@ FreeBSD Documentation Release README -*- text -*- $FreeBSD$ This is a collection of documents from the FreeBSD Documentation -Project, in a variety of output formats. +Project, in a variety of output formats. It includes material from +the FreeBSD doc/ tree, as well as (optionally) release documentation +for some specific version of FreeBSD. -Top-level directories with names of the form <lang>.<encoding> hold -versions of documentation in different languages. Generally, -documents are written in American English (en_US.ISO8859-1) and -translated to other languages by translation teams. +The doc/ subdirectory contains a number of subdirectories with names +of the form <lang>.<encoding>, which hold versions of documentation in +different languages. Generally, documents are written in American +English (en_US.ISO8859-1) and translated to other languages by +translation teams. -Beneath the language directories, documents are classified into books +Beneath the language directories, documents may be classified into books or articles. Articles are generally 25 pages or less in length, while books can be any length. @@ -48,6 +51,9 @@ rtf Microsoft's Rich Text Format (article.rtf or book.rtf, into Microsoft Word. Press CTRL+A, CTRL+END, F9, after loading the document, to update the page numbers. +Release documentation, if present, is contained in a src/release/doc +directory, and follows similar conventions to those described above. + build.txt in the top-level directory gives more information about the particular set of languages and formats contained in this release build. |