summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorerorcun <erayorcunus@gmail.com>2020-11-26 22:41:29 +0100
committerGitHub <noreply@github.com>2020-11-26 22:41:29 +0100
commit53162e23b6a792a3d9a226e67d1fcd8c9012364c (patch)
treece8422e3412428af812c19318b605bed4fd764ba
parentSome TODOs done in Peds code (diff)
downloadre3-53162e23b6a792a3d9a226e67d1fcd8c9012364c.tar
re3-53162e23b6a792a3d9a226e67d1fcd8c9012364c.tar.gz
re3-53162e23b6a792a3d9a226e67d1fcd8c9012364c.tar.bz2
re3-53162e23b6a792a3d9a226e67d1fcd8c9012364c.tar.lz
re3-53162e23b6a792a3d9a226e67d1fcd8c9012364c.tar.xz
re3-53162e23b6a792a3d9a226e67d1fcd8c9012364c.tar.zst
re3-53162e23b6a792a3d9a226e67d1fcd8c9012364c.zip
-rw-r--r--README.md20
1 files changed, 12 insertions, 8 deletions
diff --git a/README.md b/README.md
index 1bfe74d2..ef850f59 100644
--- a/README.md
+++ b/README.md
@@ -21,14 +21,18 @@ such that we have a working game at all times.
## Preparing the environment for building
-- Clone the repo using the argument `--recursive`.
-- Point GTA_III_RE_DIR environment variable to GTA3 root folder.
-- Run premake
- - On Windows: one of the `premake-vsXXXX.cmd` variants on root folder
- - On Linux: proceed to [Building on Linux](https://github.com/GTAmodding/re3/wiki/Building-on-Linux).
-- There are various settings at the very bottom of [config.h](https://github.com/GTAmodding/re3/tree/master/src/core/config.h), you may want to take a look there. i.e. FIX_BUGS define fixes the bugs we've come across.
-- **If you use 64-bit D3D9**: We don't ship 64-bit Dx9 SDK. You need to download it from Microsoft if you don't have it(although it should come pre-installed after some Windows version)
-
+You may want to point GTA_VC_RE_DIR environment variable to GTA VC root folder if you want executable to be moved there via post-build script.
+
+- For Linux, proceed: [Building on Linux](https://github.com/GTAmodding/re3/wiki/Building-on-Linux)
+- For FreeBSD, proceed: [Building on FreeBSD](https://github.com/GTAmodding/re3/wiki/Building-on-FreeBSD)
+- For Windows, assuming you have Visual Studio:
+ - Clone the repo using the argument `--recursive`.
+ - Run one of the `premake-vsXXXX.cmd` variants on root folder.
+ - Open the project via Visual Studio
+
+**If you use 64-bit D3D9**: We don't ship 64-bit Dx9 SDK. You need to download it from Microsoft if you don't have it(although it should come pre-installed after some Windows version)
+
+There are various settings at the very bottom of [config.h](https://github.com/GTAmodding/re3/tree/master/src/core/config.h), you may want to take a look there. i.e. FIX_BUGS define fixes the bugs we've come across.
> :information_source: **If you choose OpenAL on Windows** You must read [Running OpenAL build on Windows](https://github.com/GTAmodding/re3/wiki/Running-OpenAL-build-on-Windows).