summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWilliam S Fulton <wsf@fultondesigns.co.uk>2013-01-12 00:23:16 +0000
committerWilliam S Fulton <wsf@fultondesigns.co.uk>2013-01-12 00:23:16 +0000
commitacfc4cad3b0e01280520cff6bb10e9e7f6ffa0c4 (patch)
treea54b48a944f8e27e1d347e3a2cded663968abaf7
parent7408332eb59f5c852331eead60a8f7b460272980 (diff)
downloadswig-acfc4cad3b0e01280520cff6bb10e9e7f6ffa0c4.tar.gz
Update README file
-rw-r--r--README48
1 files changed, 25 insertions, 23 deletions
diff --git a/README b/README
index 305edf078..d69e7c6d8 100644
--- a/README
+++ b/README
@@ -3,9 +3,11 @@ SWIG (Simplified Wrapper and Interface Generator)
Version: 2.0.10 (in progress)
Tagline: SWIG is a compiler that integrates C and C++ with languages
- including Perl, Python, Tcl, Ruby, PHP, Java, Ocaml, Lua,
- Scheme (Guile, MzScheme, CHICKEN), Pike, C#, Modula-3,
- Common Lisp (CLISP, Allegro CL, CFFI, UFFI), Octave and R.
+ including Perl, Python, Tcl, Ruby, PHP, Java, C#, D, Go, Lua,
+ Octave, R, Scheme (Guile, MzScheme/Racket, CHICKEN), Ocaml,
+ Modula-3, Common Lisp (CLISP, Allegro CL, CFFI, UFFI) and Pike.
+ SWIG can also export its parse tree into Lisp s-expressions and
+ XML.
SWIG reads annotated C/C++ header files and creates wrapper code (glue
code) in order to make the corresponding C/C++ libraries available to
@@ -31,6 +33,22 @@ new features for the current release. The CHANGES file contains bug fixes
and new features for older versions. A summary of changes in each release
can be found in the RELEASENOTES file.
+Documentation
+=============
+The Doc/Manual directory contains the most recent set of updated
+documentation for this release. The documentation is available in
+three different formats, each of which contains identical content.
+These format are, pdf (Doc/Manual/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.
+
+There is some technical developer documentation available in the
+Doc/Devel subdirectory. This is not necessarily up-to-date, but it
+has some information on SWIG internals.
+
+Documentation is also online at http://www.swig.org/doc.html.
+
Backwards Compatibility
=======================
The developers strive their best to preserve backwards compatibility
@@ -97,9 +115,6 @@ minimal effect. All they do is reduce the amount of testing done with
'make check'. The SWIG executable and library files installed cannot currently
be configured with a subset of target languages.
-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
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
@@ -108,7 +123,7 @@ examples which build the runtime library.
Notes:
-(1) If you checked the code out via SVN, you will have to run ./autogen.sh
+(1) If you checked the code out via Git, you will have to run ./autogen.sh
before typing 'configure'. In addition, a full build of SWIG requires
the a number of packages to be installed. Full instructions at
http://www.swig.org/svn.html
@@ -175,8 +190,9 @@ The Examples directory contains a variety of examples of using SWIG
and it has some browsable documentation. Simply point your browser to
the file "Example/index.html".
-The Examples directory also includes Visual C++ project (.dsp) files for
-building some of the examples on Windows.
+The Examples directory also includes Visual C++ project 6 (.dsp) files for
+building some of the examples on Windows. Later versions of Visual Studio
+will convert these old style project files into a current solution file.
Known Issues
============
@@ -215,20 +231,6 @@ installed. To fix this:
If you are having other troubles, you might look at the SWIG Wiki at
http://www.dabeaz.com/cgi-bin/wiki.pl.
-Documentation
-=============
-The Doc/Manual directory contains the most recent set of updated
-documentation for this release. The documentation is available in
-three different formats, each of which contains identical content.
-These format are, pdf (Doc/Manual/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.
-
-There is some technical developer documentation available in the
-Doc/Devel subdirectory. This is not necessarily up-to-date, but it
-has some information on SWIG internals.
-
Participate!
============
Please report any errors and submit patches (if possible)! We only