[27410] in CVS-changelog-for-Kerberos-V5
krb5 commit: Update README for Sphinx documentation
daemon@ATHENA.MIT.EDU (Tom Yu)
Mon Dec 17 15:10:31 2012
Date: Mon, 17 Dec 2012 15:10:28 -0500
From: Tom Yu <tlyu@mit.edu>
Message-Id: <201212172010.qBHKASuY011369@drugstore.mit.edu>
To: cvs-krb5@mit.edu
Reply-To: krbdev@mit.edu
MIME-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: cvs-krb5-bounces@mit.edu
https://github.com/krb5/krb5/commit/2af891a5112642636986c88b474519075c392a64
commit 2af891a5112642636986c88b474519075c392a64
Author: Tom Yu <tlyu@mit.edu>
Date: Mon Dec 17 14:45:57 2012 -0500
Update README for Sphinx documentation
The README pointed at the obsolete Texinfo documentation. Update it
to point at the Sphinx documentation.
ticket: 7509 (new)
target_version: 1.11
tags: pullup
README | 44 ++++++++++++++++++++++++++++++++------------
1 files changed, 32 insertions(+), 12 deletions(-)
diff --git a/README b/README
index cc4115f..892e0c4 100644
--- a/README
+++ b/README
@@ -11,21 +11,41 @@ and its contributors. All rights reserved.
Please see the file named NOTICE for additional notices.
+Documentation
+-------------
+
+Unified documentation for Kerberos V5 is available in both HTML and
+PDF formats. The table of contents of the HTML format documentation
+is at doc/html/index.html, and the PDF format documentation is in the
+doc/pdf directory.
+
+Additionally, you may find copies of the HTML format documentation
+online at
+
+ http://web.mit.edu/kerberos/krb5-latest/doc/
+
+for the most recent supported release, or at
+
+ http://web.mit.edu/kerberos/krb5-devel/doc/
+
+for the release under development.
+
+More information about Kerberos may be found at
+
+ http://web.mit.edu/kerberos/
+
+and at the MIT Kerberos Consortium web site
+
+ http://kerberos.org/
+
Building and Installing Kerberos 5
----------------------------------
-The first file you should look at is doc/install-guide.ps; it contains
-the notes for building and installing Kerberos 5. The info file
-krb5-install.info has the same information in info file format. You
-can view this using the GNU emacs info-mode, or by using the
-standalone info file viewer from the Free Software Foundation. This
-is also available as an HTML file, install.html.
-
-Other good files to look at are admin-guide.ps and user-guide.ps,
-which contain the system administrator's guide, and the user's guide,
-respectively. They are also available as info files
-kerberos-admin.info and krb5-user.info, respectively. These files are
-also available as HTML files.
+Build documentation is in doc/html/build/index.html or
+doc/pdf/build.pdf.
+
+The installation guide is in doc/html/admin/install.html or
+doc/pdf/install.pdf.
If you are attempting to build under Windows, please see the
src/windows/README file.
_______________________________________________
cvs-krb5 mailing list
cvs-krb5@mit.edu
https://mailman.mit.edu/mailman/listinfo/cvs-krb5
