jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Make it clear that documentation is not installed by default.

Browse source 
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@8828 626c5289-ae23-0410-ae9c-e8d60b6d4f22
This commit is contained in:
William S Fulton 2006-02-16 22:10:38 +00:00
commit f3b140b3d1
1 changed files with 11 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

23
SWIG/README
View file

@ -288,7 +288,7 @@ the main SWIG distribution. There is no need to download anything else.
Unix Installation Unix Installation
================= =================
You must use GNU `make' to build Swig. You must use GNU `make' to build SWIG.
http://www.gnu.org/software/make/ http://www.gnu.org/software/make/
@ -321,6 +321,9 @@ packages to compile or run. The configure script is actually looking for
these packages so that you can try out the SWIG examples contained these packages so that you can try out the SWIG examples contained
in the 'Examples' directory without having to hack Makefiles. in the 'Examples' directory without having to hack Makefiles.
Please see the Documentation section below on installing documentation as
none is installed by default.
SWIG used to include a set of runtime libraries for some languages for working SWIG used to include a set of runtime libraries for some languages for working
with multiple modules. These are no longer built during the installation stage. with multiple modules. These are no longer built during the installation stage.
However, users can build them just like any wrapper module as described in However, users can build them just like any wrapper module as described in
@ -385,10 +388,6 @@ Note: The test-suite currently contains around 250 tests. If you
have many different target languages installed and a slow machine, it have many different target languages installed and a slow machine, it
might take more than an hour to run the test-suite. might take more than an hour to run the test-suite.
Note: Some of the tests and examples may depend on SWIG runtime libraries.
These are not built by default. Type 'make -k runtime' to build the libraries
if needed.
Examples Examples
======== ========
The Examples directory contains a variety of examples of using SWIG The Examples directory contains a variety of examples of using SWIG
@ -400,7 +399,7 @@ building some of the examples on Windows.
Known Issues Known Issues
============ ============
There are minor bugs, details of which are in the bug tracker, see There are minor known bugs, details of which are in the bug tracker, see
http://www.swig.org/bugs.html. http://www.swig.org/bugs.html.
Troubleshooting Troubleshooting
@ -438,18 +437,18 @@ http://www.dabeaz.com/cgi-bin/wiki.pl.
Documentation Documentation
============= =============
The Doc/Manual directory contains the most recent set of updated The Doc/Manual directory contains the most recent set of updated
documentation for this release. The documentation is available in documentation for this release. The documentation is available in
a single page html format, multiple page html format or pdf format, three different formats, each of which contains identical content.
see Doc/Manual/index.html. These format are, pdf (SWIGDocumentation.pdf), single
page html (Doc/Manual/SWIGDocumentation.html) or multiple page html
(other files in Doc/Manual). Please select your chosen format and
copy/install to wherever takes your fancy.
This is a development release and the documentation is largely, but This is a development release and the documentation is largely, but
not entirely up to date. We are working on it, but there not entirely up to date. We are working on it, but there
was a lot of old documentation and it is taking some time to was a lot of old documentation and it is taking some time to
update and complete. Please be patient or volunteer to help. update and complete. Please be patient or volunteer to help.
!! The most up-to-date information concerning new features in SWIG-1.3 is the
!! file Doc/Manual/SWIG.html.
There is some technical developer documentation available in the There is some technical developer documentation available in the
Doc/Devel subdirectory. This is not necessarily up-to-date, but it Doc/Devel subdirectory. This is not necessarily up-to-date, but it
has some information on SWIG internals. has some information on SWIG internals.