Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

MainPage.dxy

00001 /*!
00002 \mainpage The Studio Framework
00003 
00004 \section summary Summary
00005 
00006 The Studio Framework is a set of C++ classes that take care of the
00007 common things every application has to do, such as parameter parsing,
00008 plugin handling, runtime type information on objects, threads, curses,
00009 and scripting.
00010 
00011 \section requirements Requirements and Building
00012 
00013 Building %SFW requires the following packages:
00014 
00015 <ul>
00016 
00017     <li> A modern C++ compiler. I use gcc 2.95.2, and recommend you do
00018     too. The last version of egcs might work, too. Older versions of
00019     egcs which don't have support for 'namespace' will not work.
00020       
00021     <li> A modern libstdc++. I use libstdc++-3, and you should be too,
00022     I seriously doubt anything older will work.
00023 
00024 </ul>
00025 
00026 The following are currently optional:
00027 
00028 <ul>
00029 
00030     <li> GNU Readline - upgrade to 4.1, 2.2 has outdated headers. If
00031     you get errors regarding readline, you need to upgrade. If your
00032     distribution doesn't have one, you can find the source at:
00033 
00034         ftp://ftp.gnu.org/pub/gnu/readline/
00035 
00036     Make \em sure if you build this from source to do \c 'make \c
00037     shared' and \c 'make \c install-shared', since you need the shared
00038     libraries. You can safely remove your old readline and link \c
00039     libreadline.so.3 to the new \c libreadline.so.4, as well. (You
00040     will probably have to do this.)
00041     
00042     <li> NGS/NJS JavaScript - 0.2.5.  Many people have an older
00043     version, 0.2.4, that gets installed with various things like the
00044     KDE support libraries. This one won't work. You should be safe
00045     deleting old the libraries and headers (look for \c libjs.*, \c
00046     js.h, \c jsint.h) and installing the new ones. (I'm not even sure
00047     KDE actually \em uses that libjs. ;)
00048 
00049     This is probably not terribly easy to find unless you know where
00050     to look, which is at the following location:
00051 
00052          http://sourceforge.net/project/?group_id=3438
00053 
00054     Make sure to compile this with \c --enable-shared! It is for some
00055     reason off by default, and you will run into problems later with
00056     the static version (besides taking up more memory and disk space)
00057 
00058 </ul>
00059 
00060 After you make sure you have these things, %SFW should configure, make,
00061 and install without incident. I highly recommend you use \c epkg, the
00062 Encap Package Manager, if you have to compile any of the above from
00063 source, and for %SFW. Epkg is an excellent tool for maintaining
00064 packages built from source, written by Mark Roth. You can get epkg and
00065 find out more information about it at http://encap.cso.uiuc.edu/.
00066 
00067 If you run into any problems (other than those listed above), don't
00068 hesitate to mail me at <rpav@mythosource.org>.
00069 
00070 
00071 \section usage Usage
00072 
00073 %SFW doesn't do anything itself, it's just the class library. Go get
00074 \c TemplateFactory if you'd like to see an example-in-action, plus have a
00075 useful utility for making files.
00076 
00077 \htmlonly
00078 <P><A href="http://sourceforge.net"> <IMG
00079 src="http://sourceforge.net/sflogo.php?group_id=8624" width="88"
00080 height="31" border="0" alt="SourceForge Logo"></A></P>
00081 \endhtmlonly
00082 
00083 */

Generated at Tue Jan 2 15:38:34 2001 for SFW by doxygen1.2.4 written by Dimitri van Heesch, © 1997-2000