Browse Source

Updated Readme

Thomas Buck 11 years ago
parent
commit
e6b99e7ad2
2 changed files with 25 additions and 12 deletions
  1. 6
    6
      Makefile
  2. 19
    6
      README.md

+ 6
- 6
Makefile View File

@@ -90,7 +90,7 @@ BASE_CFLAGS=-Wall $(BASE_DEFS) \
90 90
 	-DVERSION=\"\\\"$(NAME)-$(VERSION)-$(BUILD_ID)\\\"\" \
91 91
 	-DBUILD_HOST=\"\\\"$(BUILD_HOST)\\\"\"
92 92
 
93
-LD_FLAGS=-L/opt/X11/lib -lXmu -lXt -lSM -lICE -lXext -lX11 -lXi \
93
+LD_FLAGS=-L/usr/X11/lib -lXmu -lXt -lSM -lICE -lXext -lX11 -lXi \
94 94
 	 -lm $(BASE_LIBS)
95 95
 
96 96
 ifneq ($(UNAME),Darwin)
@@ -189,7 +189,7 @@ depend:
189 189
 	@-echo "Making deps..."
190 190
 	@-echo "# Autogenerated dependency file" > depend
191 191
 	@-find ./src -name "*.cpp" -exec ./deps.sh $(BASE_DEFS) {} \; >> depend
192
-	@-echo "       [done]"
192
+	@-echo "[DONE]"
193 193
 
194 194
 ################################################################
195 195
 
@@ -237,10 +237,6 @@ endif
237 237
 
238 238
 #################################################################
239 239
 
240
--include depend
241
-
242
-#################################################################
243
-
244 240
 clean: clean-emacs clean-build clean-test clean-obj clean-dep
245 241
 	@-rm -rf bin/OpenRaider.app
246 242
 	@-rm -rf bin/OpenRaider.dmg
@@ -286,6 +282,10 @@ clean-deb:
286 282
 
287 283
 #################################################################
288 284
 
285
+-include depend
286
+
287
+#################################################################
288
+
289 289
 redhat:
290 290
 	cd $(DEB_DIR) && \
291 291
 		alien --to-rpm $(NAME_DEB)_$(VERSION_DEB)-1_$(ARCH).deb

+ 19
- 6
README.md View File

@@ -4,25 +4,38 @@
4 4
 
5 5
 This project aims to get OpenRaider running in a modern Unix.
6 6
 
7
-## Building
7
+## Configuration
8
+
9
+OpenRaider needs some configuration files, and level data and assets from custom levels or the Tomb Raider games.
10
+These are stored in `~/.OpenRaider`. Running the included `setup.sh` will create/copy the necessary files and directories.
11
+
12
+## Dependencies
8 13
 
9
-On Mac OS X 10.9 with [XCode](https://developer.apple.com/xcode/) and [MacPorts](http://www.macports.org) installed, the following should be enough to get all dependencies:
14
+On Mac OS X 10.9 with [XCode](https://developer.apple.com/xcode/) and [MacPorts](http://www.macports.org) installed, the following should be enough to get all dependencies that are available as port:
10 15
 
11 16
     sudo port install zlib cmake libsdl libsdl_ttf
12 17
 
13
-You will also need an installed [X11 Server](http://xquartz.macosforge.org/trac)!
18
+You also need the  [XQuartz](http://xquartz.macosforge.org/trac) X11 Server.
14 19
 
15
-Also, to get Sound, get [freealut](https://github.com/vancegroup/freealut) and compile it like this:
20
+To get Sound, you need [freealut](https://github.com/vancegroup/freealut). Get, compile and install it like this:
16 21
 
22
+    git clone git@github.com:vancegroup/freealut.git
17 23
     mkdir build
18 24
     cd build
19 25
     cmake .. -DCMAKE_INSTALL_PREFIX:STRING="/opt/local" -DCMAKE_C_FLAGS:STRING="-O2"
20 26
     make
21 27
     sudo make install
22 28
 
23
-Then, just `make debug` and run bin/debug/OpenRaider.
29
+## Building
30
+
31
+Just `make debug` and run `bin/debug/OpenRaider` for a debug build.
32
+`make release` builds a release binary.
33
+`make bundle` creates a Mac App Bundle that also runs the setup script, if necessary.
34
+`make bundle-image` packs the App Bundle into a DMG ready for distribution.
35
+
36
+## Usage
24 37
 
25
-Alternatively, run `make bundle` to create a Mac App Bundle, or `make bundle-image` to put this App Bundle in a Distributable .DMG file.
38
+See the original `README.old` file. In the Main Menu, <Esc> will allow you to select a level to play.
26 39
 
27 40
 ## License
28 41
 

Loading…
Cancel
Save