Menu
▾
▴
SF.net SVN: alleg:[12741] allegro/branches/4.4/docs/src
|
From: <tj...@us...> - 2009-11-22 11:40:51
|
Revision: 12741
http://alleg.svn.sourceforge.net/alleg/?rev=12741&view=rev
Author: tjaden
Date: 2009-11-22 11:40:42 +0000 (Sun, 22 Nov 2009)
Log Message:
-----------
Some updates to build docs.
Modified Paths:
--------------
allegro/branches/4.4/docs/src/abi._tx
allegro/branches/4.4/docs/src/api._tx
allegro/branches/4.4/docs/src/build/cmake._tx
allegro/branches/4.4/docs/src/build/mingw32._tx
allegro/branches/4.4/docs/src/build/msvc._tx
allegro/branches/4.4/docs/src/build/unix._tx
allegro/branches/4.4/docs/src/readme._tx
Modified: allegro/branches/4.4/docs/src/abi._tx
===================================================================
--- allegro/branches/4.4/docs/src/abi._tx 2009-11-22 11:39:58 UTC (rev 12740)
+++ allegro/branches/4.4/docs/src/abi._tx 2009-11-22 11:40:42 UTC (rev 12741)
@@ -103,7 +103,7 @@
For example, otool -L <mybinary> should give
- liballeg-4.4.dylib (compatibility version 4.4.0, current version 4.4.0)
+ liballeg.4.4.dylib (compatibility version 4.4.0, current version 4.4.0)
For the Mac style, use `allegro-config --frameworks` on the link
line, or add `Allegro.framework' to your project if you are using
Modified: allegro/branches/4.4/docs/src/api._tx
===================================================================
--- allegro/branches/4.4/docs/src/api._tx 2009-11-22 11:39:58 UTC (rev 12740)
+++ allegro/branches/4.4/docs/src/api._tx 2009-11-22 11:40:42 UTC (rev 12741)
@@ -37,6 +37,7 @@
fixed; in other words, two stable versions that differ from each other
only by the revision (3rd) number will be strictly backward compatible.
+
@heading
Changes between 4.2.x and 4.4.x series
<ul><li>
Modified: allegro/branches/4.4/docs/src/build/cmake._tx
===================================================================
--- allegro/branches/4.4/docs/src/build/cmake._tx 2009-11-22 11:39:58 UTC (rev 12740)
+++ allegro/branches/4.4/docs/src/build/cmake._tx 2009-11-22 11:40:42 UTC (rev 12741)
@@ -8,8 +8,9 @@
CMake is a cross-platform tool that can generate native makefiles and
workspaces that can be used in the compiler environment of your choice.
- Allegro 4.4 uses CMake as it's build system. The process is essentially the
+ Allegro 4.4 uses CMake as its build system. The process is essentially the
same for all compilers. You will need CMake 2.6 or later.
+ The CMake web site is <link>http://www.cmake.org/</a>.
<ol><li>
Create a temporary directory to build in. This is optional but recommended.
If something goes wrong you can delete the build directory and try again.
Modified: allegro/branches/4.4/docs/src/build/mingw32._tx
===================================================================
--- allegro/branches/4.4/docs/src/build/mingw32._tx 2009-11-22 11:39:58 UTC (rev 12740)
+++ allegro/branches/4.4/docs/src/build/mingw32._tx 2009-11-22 11:40:42 UTC (rev 12741)
@@ -155,6 +155,8 @@
@heading
Setting up Cygwin to build Allegro
+ Note: Allegro 4.4 has not been tested with Cygwin yet!
+
The procedure is as follows:
<blockquote>
1. Make sure you have a working Cygwin installation. You can download the
@@ -194,10 +196,8 @@
Cygwin. This is expected to be fixed in a later release of the
mingw-runtime package (I'm currently using mingw-runtime-1.2-1).
- Note: Allegro 4.4 has not been tested with Cygwin.
-
@heading
Cross compilation
@@ -249,20 +249,20 @@
@heading
Using Allegro
- XXX some of the library names are wrong right now
-
All the Allegro functions, variables, and data structures are defined
in <tt>allegro.h</tt>. You should include this in your programs, and link with
either the optimised library <tt>liballeg.a</tt>, the debugging library
- <tt>liballd.a</tt>, or the profiling library <tt>liballp.a</tt>. You should include the
- Allegro DLLs in any software you release to the public.
+ <tt>liballeg-debug.a</tt>, or the profiling library <tt>liballeg-profile.a</tt>.
+ You should include the Allegro DLLs in any software you release to the
+ public.
When using a statically linked library, you must define the preprocessor
symbol <tt>ALLEGRO_STATICLINK</tt> before including any of the Allegro headers and
link your program against Allegro and the main Win32/DirectX libraries
- in that order. The names of
- the statically linked Allegro libraries are post-fixed with '<tt>_s</tt>' so that
- you will link with either <tt>liballeg_s.a</tt>, <tt>liballd_s.a</tt> or <tt>liballp_s.a</tt>.
+ in that order. The names of the statically linked Allegro libraries are
+ post-fixed with '<tt>-static</tt>' so that you will link with either
+ <tt>liballeg-static.a</tt>, <tt>liballeg-debug-static.a</tt> or
+ <tt>liballeg-profile-static.a</tt>.
Don't forget that you need to use the <code>END_OF_MAIN()</code> macro right after
your <code>main()</code> function.
Modified: allegro/branches/4.4/docs/src/build/msvc._tx
===================================================================
--- allegro/branches/4.4/docs/src/build/msvc._tx 2009-11-22 11:39:58 UTC (rev 12740)
+++ allegro/branches/4.4/docs/src/build/msvc._tx 2009-11-22 11:40:42 UTC (rev 12741)
@@ -101,20 +101,16 @@
@heading
Using Allegro
- XXX some of the library names are wrong right now
-
All the Allegro functions, variables, and data structures are defined in
<tt>allegro.h</tt>. You should include this in your programs, and link with one of
the libraries:
<textblock>
- alleg.lib - optimised DLL import library
- alld.lib - debugging DLL import library
- allp.lib - profiling DLL import library
- alleg_s.lib - statically linked optimised library
- alld_s.lib - statically linked debugging library
- allp_s.lib - statically linked profiling library
- alleg_s_crt.lib - statically linked optimised library
- with the static C runtime
+ alleg.lib - optimised DLL import library
+ alleg-debug.lib - debugging DLL import library
+ alleg-profile.lib - profiling DLL import library
+ alleg-static.lib - statically linked optimised library
+ alleg-debug-static.lib - statically linked debugging library
+ alleg-profile-static.lib - statically linked profiling library
<endblock>
When using a statically linked library, you must define the preprocessor
symbol <tt>ALLEGRO_STATICLINK</tt> before including any of the Allegro headers and
@@ -131,8 +127,3 @@
If you use one of the DLL versions, you will obviously need to distribute
the appropriate DLL along with your program.
-
- The alleg_s_crt.lib is most useful with Visual C++ 8.0. The new C runtime that it
- uses can be difficult to distribute. By using alleg_s_crt.lib along with the
- multi-threaded runtime (/MT) you can avoid the problem. For more information on
- deploying with VC++ 8.0, see <link>http://wiki.allegro.cc/VisualCExpress2005#Deployment</a>.
Modified: allegro/branches/4.4/docs/src/build/unix._tx
===================================================================
--- allegro/branches/4.4/docs/src/build/unix._tx 2009-11-22 11:39:58 UTC (rev 12740)
+++ allegro/branches/4.4/docs/src/build/unix._tx 2009-11-22 11:40:42 UTC (rev 12741)
@@ -57,8 +57,6 @@
@heading
Shared files
- XXX allegro.m4 not installed yet
-
Installing Allegro will copy the library and header files plus other
support files. These are:
<ul><li>
@@ -66,8 +64,7 @@
for your system in order to compile Allegro. This is copied into a
`.../bin' path.
<li>
- allegro.m4: Autoconf support file to include in your `./configure'
- scripts. Copied into a `.../share/aclocal' path.
+ pkg-config files. These are alternatives to the allegro-config script.
</ul>
On the other hand, there are files which you, as system administrator, are
required to installed manually. These are:
@@ -100,7 +97,7 @@
To avoid you having to work out the right linker commands for
yourself, the installation creates a script, <tt>allegro-config</tt>, that will
- print out a suitable commandline. You can use this inside a backtick
+ print out a suitable command line. You can use this inside a backtick
command substitution, for example:
<textblock>
gcc myfile.c -o myprogram `allegro-config --libs`
@@ -117,6 +114,12 @@
libraries, in case you installed both. Run allegro-config without any
arguments for a full list of options.
+ You can also use pkg-config instead, for example:
+<textblock>
+ gcc myfile.c -o myprogram `pkg-config --libs allegro loadpng`
+<endblock>
+ As shown, there are pkg-config files for the bundled addons as well.
+
Don't forget that you need to use the <code>END_OF_MAIN()</code> macro right after
your <code>main()</code> function!
@@ -143,11 +146,8 @@
can change the target directories for installation -- for example,
you can write:
<textblock>
- ./configure --prefix=$HOME
+ cmake -DCMAKE_INSTALL_PREFIX=$HOME ..
<endblock>
- Be a bit careful, <tt>--prefix=~</tt> works in bash but not tcsh -- it's safer
- to use <tt>$HOME</tt> if you're not sure.
-
Then binaries will be installed to the `<tt>bin</tt>' subdirectory of your home
directory, libraries to `<tt>lib</tt>', etc. Now you need to set up your system
so that it knows where to find a few things, if this has not been done
Modified: allegro/branches/4.4/docs/src/readme._tx
===================================================================
--- allegro/branches/4.4/docs/src/readme._tx 2009-11-22 11:39:58 UTC (rev 12740)
+++ allegro/branches/4.4/docs/src/readme._tx 2009-11-22 11:40:42 UTC (rev 12741)
@@ -76,27 +76,22 @@
@heading
-Supported platforms
+Installation and supported platforms
- For instructions on how to install Allegro, how to link your programs
- with it, and any additional information specific to each of the supported
- platforms, see one of the files included in the distribution package:
+ For generic instructions on how to build and install Allegro, see
+ docs/build/cmake.txt.
+
+ For more information on specific platforms, see one of these files:
<textblock>
- DOS/djgpp - see docs/build/djgpp.txt
- DOS/Watcom - see docs/build/watcom.txt
Windows/MSVC - see docs/build/msvc.txt
Windows/MinGW - see docs/build/mingw32.txt
Windows/Cygwin - see docs/build/mingw32.txt
- Windows/Borland - see docs/build/bcc32.txt
- Linux (console) - see docs/build/linux.txt
Unix (X11) - see docs/build/unix.txt
- Darwin (X11) - see docs/build/darwin.txt
- BeOS - see docs/build/beos.txt
- QNX - see docs/build/qnx.txt
MacOS X - see docs/build/macosx.txt
+ Linux (console) - see docs/build/linux.txt
<endblock>
- Note: many of those platforms were supported in the past, but may not be any
- longer, without effort from interest parties. Sorry.
+ Other platforms were supported in the past, but may no longer work without
+ effort from interest parties. Sorry.
General API information can be found in the main manual, usually referred
to as docs/txt/allegro.txt, allegro.txt or simply "The Allegro manual"
@@ -122,9 +117,10 @@
<li>jpgalleg
</ul>
-See docs/txt/addons.txt.
+ See docs/txt/addons.txt.
+
@heading
Features
<ul><li>
@@ -221,6 +217,8 @@
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
+
+
@heading
Configuration
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|