Fixed README.

This commit is contained in:
Alexander Yakovlev 2011-09-03 18:24:04 +07:00
parent 11cdfd4c4f
commit bd13b2f516
1 changed files with 20 additions and 66 deletions

86
README
View File

@ -1,77 +1,31 @@
Steed 0.2
Steed 1.0
=============
Powerful text-oriented game engine in SDL and Lua.
WARNING! For successfull building you must install these development packages (names may vary in your distribution):
Dependencies
============
- gtk+-2.0
- sdl
- sdl-mixer
- sdl-image
- sdl-ttf
- lua5.1
- libsoup-2.4 (optional for downloading support)
- zlib (optional, also included with the program)
sdl, sdl-mixer, sdl-image, sdl-ttf, lua5.1
Also you'll need GNU C Compiler, bash and GNU make for building.
0) Prepare for building
=======================
Building
========
Unpack source package with this command:
$ tar xzvf instead_<version>.tar.gz
Typically, it's:
Change current dir to project's build dir:
$ cd instead-<version>
There are several ways to build package.
1) On Debian based systems you can build deb package
====================================================
$ sudo apt-get install liblua5.1-dev libreadline-dev libsdl1.2-dev libsdl-ttf2.0-dev libsdl-image1.2-dev libsdl-mixer1.2-dev
$ sudo apt-get install build-essential debhelper
$ debuild
$ cd ..
$ sudo dpkg -i instead_<version>.deb
2) On gentoo or arch linux
==========================
Install stable version from AUR:
$ yaourt -S instead
Or build from svn:
$ make PKGBUILD
$ makepkg -s
And, I think, you have enough skills to build package yourself. ;)
3) For other distributions
==========================
You have a two choices:
a) try run ./configure.sh and follow instructions
or
b) do all things manually
4) Manual build
===============
To build game, that runs just from build dir use Rules.make.standalone
----------------------------------------------------------------------
$ rm -f Rules.make
$ ln -s Rules.make.standalone Rules.make
$ make clean
$ make
If build process has failed check Rules.make.standalone and make changes if needed.
$ ./sdl-instead
To build game for system install
--------------------------------
$ rm -f Rules.make
$ ln -s Rules.make.system Rules.make
$ make clean
$ make
If build process has failed check Rules.make.system and make changes if needed.
$ sudo make install
$ sdl-instead
Enjoy.
1. configure
2. make
3. make install (optional)
Known problems
==============
- Does not clears up when Alt+Q _and_ game is unpacked [INSTEAD bug]
- Free Software Foundation insists on placing GPL preamble in every file; this is not the case.
- Does not clears up downloaded game archives