
	SUMMARY

* What can I find in the different packages?
* Are any files duplicated?
* What's that?!? The sswf project?!?
* What can I really do?



* What can I find in the different packages?

The packages are defined with a name such as:

sswf-<version>-<module>-<system>-<architecture>.<extension>

The <system> and <architecture> are not present for
platform independent packages. The currently supported
systems are:

   . linux

     At this time, I'm usually compiling under
     RedHat 8.0. You can also run this software
     under Debian and Slackware (reported to work
     on both) and most certainly many other flavors.
     It started on Linux RedHat 6.2.

   . win32

     You have a MS-Windows 32bits version. If you
     don't have MinGW or want to use SSWF outside
     of MinGW, then  you should select this version.
     Since v1.4.1 it is compiled library independent
     which means you don't have to download any DLL
     to make these binaries work.

     There is now an installer (-win32.exe) to ease
     your installation of SSWF. Note that the installer
     includes the binaries, the documentation and the
     source files.

     Note: precompiled versions were compiled under
     MS-Windows 2000 and may or may not work on
     older systems (though, I make no use of GUI
     functions, so there shouldn't be any problem
     to run these under MS-Windows 95, 98, ME & NT).
     I have heard that some people are using it
     under Windows 98.

   . darwin

     This is a version of SSWF compiled on Mac OS/X.
     It will run on your Mac once properly installed.
     It requires Mac OS/X in order to work properly.
     Older versions work under 10.2 and newer once
     under 10.3. The source code should compile
     under older and newer versions. Compiling
     requires fink (http://fink.sourceforge.net).
     The debian packages require fink, the .dmg
     (disk image) doesn't.

   . mingw

     This is the MS-Windows 32bits version which
     incorporates itself in the MinGW environment.
     You can decompress these modules in your
     MinGW root directory as you do with the
     GNUWin32 modules.

     Note that this version depends on several
     DLLs which can all be found for free on
     the internet here:

     http://sourceforge.net/projects/gnuwin32

   . irix

     There is now a version which compiles under
     IRIX 6.5. It includes everything. The binaries
     are linked against the .a libraries so you
     shouldn't need to upload any of the freeware
     software to run the tools. Finally, I put the
     time in creating a .tardist file for IRIX.

   . Other Unices

     Since there is now a configure script, it
     is very likely that other Unices will
     support SSWF mostly as is. If you want to
     test and report whether it works, I can
     add information about additional systems
     here.



The currently supported architectures are as follow:

   . i486

     Works on an 80486 and any Pentium system

   . i686

     Works on an 80686, that is, any Pentium II or
     equivalent and better processor.

   . mipsR5k

     Works on the MIPS processors R5000 or better.

   . powerpc

     Works on PowerPC processors.

Note: at this time there is no assembly language
and thus specific processor features (such as
MMX and SSE) are not required.


The <version> is obviously defining the release
number of the <module>.

The <module> is one of the following:

   . doc

     This is the documentation. You probably
     want it if you wish to learn how to use
     the different tools. At this time, thought,
     there are still many things to work on.
     I'm however glad to mention that there is
     now a tutorial.

     You have the Alexis' SWF Reference, the
     SSWF Reference, the SWF Library Reference
     and the manual pages in man and HTML
     formats.

     All the documentation is always available
     on the SSWF official web sites:

	http://sswf.m2osw.com
	http://sswf.sourceforge.net


   . src

     For those who wish to see and/or work on the
     source code, it is available here. It includes
     everything you need to compile all the tools
     on the different systems and architectures
     supported. It includes a pre-defined configure
     script and all its companions.

     The documentation is not part of this package
     any more. Download the doc module also if you
     want the full documentation.

     NOTE: the configure script will allow you to
     install the documentation if you extracted it
     in the same folder as the source.


   . dev

     Similar to the src version without the configure
     script. If you like to use amake instead then
     you only need this version. There are many files
     appearing all over the place when using the
     configure + make versus amake. However, the
     configure will make the package work on many
     more systems (of course!)

     Also, the dev version includes all these scripts
     I use to copy packages and modules around and
     have them all compiled on all of my systems.
     You will find the source of the web page. And
     some other goodies which probably won't interest
     you much but are useful for the packaging of
     SSWF.


   . bin

     This is a compiled version of the tools which
     works on the specified system with the
     specified or a better architecture.

     On Linux & MinGW, the ft2sswf tool uses the shared
     FreeType library 2.1.x. It is required for the
     tool to start on your system. Note that the win32
     packages don't have any shared library linked.

     Since version 1.7.0, iconv is also required. The
     fink version uses the shared library of iconv
     coming with fink. The Mac OS/X disk image doesn't
     require fink however.

     At this time, the sswf links against the static
     libsswf.a library. So you don't need to download
     the libraries to run your program (except under
     fink and rpm, but since the installation will
     automatically include the shared libraries...)

     The manuals (man1) are included in this module.


   . lib

     This is a compiled version of the library.
     For PCs, it works on any system which has at
     least a Pentium II processor.

     The package also includes the library header
     files so you can compile against the library
     to create your own tools without having to
     recompile this library.


   . <empty>

     When no module is specified it usually means that
     the module includes all of the above except dev.
     This is true for the IRIX tardist and the Windows
     installer.


The extension shows the mode of compression or a specific
package:

   . tar.gz

     Compressed with gzip. You can uncompress these files
     with 'gunzip -c <filename> | tar xf -'.

     With newer versions of tar you can also type:
     'tar xzf <filename>'

   . tar.bz2

     Compressed with bzip2. You can uncompress these files
     with 'bunzip2 -c <filename> | tar xf -'.

     With newer versions of tar you can also type:
     'tar xjf <filename>'

   . zip

     Compressed with zip. You can uncompress these files
     with 'unzip <filename>'.

   . rpm

     Package created with the famous RPM tool from RedHat.
     At this time the package includes all the binaries,
     libraries and documentations. To install files present
     in these packages: 'rpm -i <filename>'. There is now
     a source RPM package for developers.

   . deb

     There are two sets of packages created with the .deb
     extension. One is for Debian and the other is for
     Mac OS/X. On Mac OS/X, you should use Fink Commander
     to install these .deb files. On Debian, use your
     usual command line (dpkg --install ... or apt-get...)

     NOTE: there is no debian packages as of yet, but it
     should soon be available.

   . tardist

     A tar distribution for IRIX. This is compatible with
     the inst command line installer and the package
     installer tool of IRIX. The package includes the
     source code as well as the binaries.

   . exe

     An executable for MS-Windows which is a graphical
     installer. It will ask you where you want to install
     SSWF on your system.


* Are any files duplicated?

Yes! Some of the files (mainly the list of authors, todo,
install, etc.) are duplicated in nearly all the packages.
It is normal to get a message of these being overwritten
and it is fine since they are the same in all the packages.


* What's that?!? The sswf project?!?

The sswf project is a set of tools to work with .swf
movies (also known as Flash movies).


* What can I really do?

At this time, you have the following tools
available to you in this package:

   . sswf

     A compiler which takes .sswf script files
     and transforms them in .swf files.

   . swf_dump

     A flash movie disassembler. Note that even
     if there is a Protect or Debug tag, the
     whole movie will still be printed out.

     It can be used to extract the lossless
     images (in uncompressed targa files) and
     JPEG images (in JPEG files - these are
     unchanged from the original).

     It can also dump some parts such as
     shapes and fonts in SSWF format (i.e.
     that you can then re-compile using
     sswf).

   . ft2sswf

     A font to sswf scripts convertor. This
     works by reading a font such as a TrueType
     or Type1 (postscript) and it generates
     the corresponding glyph and font objects
     that sswf can later transform in a
     DefineFont2 tag in your .swf movie.

   . libsswf.{a,so,dylib}

     The sswf library is a high level library
     one can use to create Flash movies without
     being bounded to the Macromedia license.

     This library is used by the sswf tool.

     Though at this time only the Save() is
     available, it can generate movies without
     you having to have too much knowledge of
     all the underlaying levels of the .swf
     format.


