os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update README to correspond to new file layout.

Browse source
This commit is contained in:
Bruce A. Mah 2006-11-11 20:15:30 +00:00
parent 90e5fd03d4
commit 40e4d6e0cb
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=29056
1 changed files with 12 additions and 6 deletions

18
release/texts/README
View file

@ -2,14 +2,17 @@ FreeBSD Documentation Release README -*- text -*-
$FreeBSD$ $FreeBSD$
This is a collection of documents from the FreeBSD Documentation 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 The doc/ subdirectory contains a number of subdirectories with names
versions of documentation in different languages. Generally, of the form <lang>.<encoding>, which hold versions of documentation in
documents are written in American English (en_US.ISO8859-1) and different languages. Generally, documents are written in American
translated to other languages by translation teams. 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 or articles. Articles are generally 25 pages or less in length, while
books can be any length. 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 into Microsoft Word. Press CTRL+A, CTRL+END, F9, after
loading the document, to update the page numbers. 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 build.txt in the top-level directory gives more information about the
particular set of languages and formats contained in this release particular set of languages and formats contained in this release
build. build.