Skip to content

Commit

Permalink
Minor updates to the build documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Peter Wang committed Jan 8, 2011
1 parent afa5c9d commit 86868e5
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 10 deletions.
23 changes: 17 additions & 6 deletions README.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
% Allegro 5.0.0 RC1
% Allegro 5

Overview
========

Welcome to Allegro 5, a cross-platform game programming library.
Currently supported platforms are Linux/Unix, Windows, MacOS X and iPhone.
Expand Down Expand Up @@ -50,17 +53,17 @@ those, nothing will work. These are required for the core library:
<http://www.g-productions.net/list.php?c=files_devpak>

- X11 development libraries (Linux/Unix only)
The libraries will be part of you Linux distribution, but you may have to
The libraries will be part of your Linux distribution, but you may have to
install them explicitly.

- OpenGL development libraries (except on Windows)
- OpenGL development libraries (optional only on Windows)

The addons, too, may require additional libraries. Since the addons are
strictly optional, they are not required to build Allegro, but a lot of
functionality may be disabled if they are not present.

Windows users may find some precompiled binaries from
<http://gnuwin32.sourceforge.net/>. You need to get the `bin` and `lib`
Windows users may find some precompiled binaries for the additional libraries
from <http://gnuwin32.sourceforge.net/>. You need to get the `bin` and `lib`
packages. The `bin` packages contain DLLs, and the `lib` packages contain the
headers and import libraries.

Expand All @@ -77,13 +80,21 @@ These are the dependencies required for the addons:
Home page: <http://www.libpng.org/pub/png/>
Windows binaries: <http://gnuwin32.sourceforge.net/packages/libpng.htm>

On Windows/Mac OS X/iPhone, PNG image support is available by using the
native facilities on the respective operating systems, so libpng is not
required.

- libjpeg, for JPEG image support (Unix and older MinGW only)
Home page: <http://www.ijg.org/>
Windows binaries: <http://gnuwin32.sourceforge.net/packages/jpeg.htm>

On Windows/Mac OS X/iPhone, JPEG image support is available by using the
native facilities on the respective operating systems, so libjpeg is not
required.

- FreeType, for TrueType font support.
Home page: <http://freetype.sourceforge.net/>
Window binaries: <http://gnuwin32.sourceforge.net/packages/freetype.htm>
Windows binaries: <http://gnuwin32.sourceforge.net/packages/freetype.htm>

- Ogg Vorbis, a free lossy audio format. (libogg, libvorbis, libvorbisfile)
Home page: <http://www.vorbis.com/>
Expand Down
3 changes: 3 additions & 0 deletions README_macosx.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
Mac OS X-specific notes
=======================

Building Allegro on Mac OS X is the same as on other Unix-like operating systems.
See README_make.txt. You may also use Xcode but that is not covered there.

Expand Down
11 changes: 7 additions & 4 deletions README_make.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
Building Allegro with make
==========================

This document discusses building Allegro using CMake and GNU make from a
terminal window. This document applies to Unix-like operating systems such as
Linux, and also Mac OS X and MinGW.
Expand Down Expand Up @@ -32,13 +35,13 @@ More examples:

cmake .. -G "MSYS Makefiles"

4. Now, if that step was successful you can run make to build Allegro.
On MinGW your make might actually be called mingw32-make.
4. Now, if that step was successful you can run `make` to build Allegro.
On MinGW your make might actually be called `mingw32-make`.

make

Since multicore processors are common now, you might wish to speed that up by
passing "-j<n>" option, where <n> is the number of parallel jobs to spawn.
passing a "-j<n>" option, where <n> is the number of parallel jobs to spawn.


5. You may optionally install Allegro into your system path with the install
Expand All @@ -48,7 +51,7 @@ target.

MinGW users might need to set the MINGDIR environment variable first.

The DESTDIR is supported, for staged installs.
The DESTDIR variable is supported for staged installs.

make install DESTDIR=/tmp/allegro-package

3 changes: 3 additions & 0 deletions README_msvc.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
Building Allegro with MSVC
==========================

There are a lot of variations to the build process, but we will just stick with
one to keep things simple. If you know what you are doing, you can do
something else.
Expand Down

0 comments on commit 86868e5

Please sign in to comment.