c4ab126805
enough for most people, and gets it into the repository, making it easier for others to add to as necessary. This has not (yet) been turned on in the upper level Makefile or listed on the web site yet, I want to get some more feedback from readers first. It should be "made visible" later this week.
89 lines
3.3 KiB
Text
89 lines
3.3 KiB
Text
<!-- Copyright (c) 1998, 1999 Nik Clayton, All rights reserved.
|
|
|
|
Redistribution and use in source (SGML DocBook) and 'compiled' forms
|
|
(SGML HTML, PDF, PostScript, RTF and so forth) with or without
|
|
modification, are permitted provided that the following conditions
|
|
are met:
|
|
|
|
1. Redistributions of source code (SGML DocBook) must retain the above
|
|
copyright notice, this list of conditions and the following
|
|
disclaimer as the first lines of this file unmodified.
|
|
|
|
2. Redistributions in compiled form (transformed to other DTDs,
|
|
converted to PDF, PostScript, RTF and other formats) must reproduce
|
|
the above copyright notice, this list of conditions and the
|
|
following disclaimer in the documentation and/or other materials
|
|
provided with the distribution.
|
|
|
|
THIS DOCUMENTATION IS PROVIDED BY NIK CLAYTON "AS IS" AND ANY EXPRESS OR
|
|
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
DISCLAIMED. IN NO EVENT SHALL NIK CLAYTON BE LIABLE FOR ANY DIRECT,
|
|
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
|
ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE
|
|
POSSIBILITY OF SUCH DAMAGE.
|
|
-->
|
|
|
|
<chapter id="overview">
|
|
<title>Overview</title>
|
|
|
|
<para>Welcome to the FreeBSD Documentation Project, and thank you for
|
|
volunteering. One of the keys to the success of a project such as FreeBSD
|
|
is the availability of good quality documentation, and your contribution
|
|
will help that success.</para>
|
|
|
|
<para>After you have read this primer you should;</para>
|
|
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>Have an understanding of the text formats used by the
|
|
Documentation Project, and why they were chosen.</para>
|
|
</listitem>
|
|
|
|
<listitem>
|
|
<para>Be able to read and understand the source code for the Handbook,
|
|
FAQ, and website, and follow how they are converted into HTML,
|
|
PostScript, and other formats.</para>
|
|
</listitem>
|
|
|
|
<listitem>
|
|
<para>Be able to make changes to the documentation, test them, and
|
|
either contribute them back to the project or (if you have commit
|
|
privileges) commit them.</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
|
|
<para>This primer assumes that you already understand;</para>
|
|
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>How to maintain an up-to-date copy of the FreeBSD CVS tree using
|
|
CVS and one of CVSup or CTM, and how to check out particular versions
|
|
of files.</para>
|
|
|
|
<para>Alternatively, how to retrieve versions of files using the
|
|
<application>CVSWeb</application> interface.</para>
|
|
</listitem>
|
|
|
|
<listitem>
|
|
<para>How to use the ports system to download and install new
|
|
software.</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</chapter>
|
|
|
|
<!--
|
|
Local Variables:
|
|
mode: sgml
|
|
sgml-declaration: "../chapter.decl"
|
|
sgml-indent-data: t
|
|
sgml-omittag: nil
|
|
sgml-always-quote-attributes: t
|
|
sgml-parent-document: ("../book.sgml" "part" "chapter")
|
|
End:
|
|
-->
|
|
|