Skip to content

Commit

Permalink
Update build instructions on Windows and Linux
Browse files Browse the repository at this point in the history
  • Loading branch information
q4a committed Oct 6, 2018
1 parent df81e45 commit 7088efa
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 8 deletions.
24 changes: 19 additions & 5 deletions doc/howto/build-linux.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,43 @@ TITLE: X-Ray 1.6 build and setup on Linux

Required packages:
------
OpenSSL
GLEW
FreeImage
LockFile
OpenAL
TBB
Crypto++
pugixml
Theora
OGG
SDL2
LZO
JPEG


Ubuntu 18.04 build dependencies:
sudo apt install git cmake libssl-dev libogg-dev libtheora-dev libvorbis-dev libsdl2-dev liblzo2-dev libjpeg-dev libncurses5-dev
sudo apt install git cmake libglew-dev libfreeimage-dev liblockfile-dev libopenal-dev libtbb-dev libcrypto++-dev libpugixml-dev libogg-dev libtheora-dev libvorbis-dev libsdl2-dev liblzo2-dev libjpeg-dev libncurses5-dev libreadline-dev

Build commands:
------
cd xray-16
git submodule update --init --recursive
mkdir bin && cd bin
cmake ..
(or export CC=clang && export CXX=clang++ && cmake ..)
make

Libraries:
#To enable debugging:
cmake .. -DCMAKE_BUILD_TYPE=Debug
#To use clang:
CC=clang CXX=clang++ cmake ..
#To enable all instruction for the local machine:
CFLAGS="-march=native" CXXFLAGS="-march=native" cmake ..
#To output log and error to different files:
make >out.log 2>error.log

Libraries (OLD LIST !!! ):
------
To build X-Ray Engine you'll need following libraries:
* Windows SDK
* BugTrap: https://github.com/Xottab-DUTY/BugTrap
* CryptoPP: https://github.com/weidai11/cryptopp
* FreeImage: http://freeimage.sourceforge.net
Expand Down
4 changes: 1 addition & 3 deletions doc/howto/build.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,10 @@ Build:
Currently, the only compiler supported is Visual C++ 2017. If you don't have Visual Studio yet, you can
download and install Visual Studio 2017 Community Edition - it's absolutely free for open source projects.

By default, all libraries mentioned below (except Windows SDK) are assumed to be in
the src\Externals directory.

Windows SDK is available from Visual Studio 2017 installer. You will definitely need to install the following items:
* Windows 8.1 SDK (or newer)
* Visual C++ MFC for x86 and x64
* C++/CLI support
* NuGet package manager

You will need following extension to save files in Visual Studio with encoding UTF-8 without BOM:
Expand Down

0 comments on commit 7088efa

Please sign in to comment.