Skip to content

Commit bc7cdc5

Browse files
committed
Update Dependency Instructions
1 parent 8bda055 commit bc7cdc5

File tree

1 file changed

+67
-2
lines changed

1 file changed

+67
-2
lines changed

README.md

Lines changed: 67 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,13 @@ Initially generated with [xmlpg](https://github.com/open-dis/xmlpg).
77

88
## Building Open DIS
99

10-
* [premake5](http://premake.github.io/) is required to build the platform specific projects. Download it and make sure it's available on your path, or specify the path to it.
10+
* [CMake](http://cmake.org/) is required to build the platform specific projects.
11+
It can be downloaded and installed from http://cmake.org/
1112

12-
* SDL2 and SDL2_net are required libraries to compile the examples. See the [.travis.yml](.travis.yml) for more details on setting up a build environment.
13+
* SDL2 and SDL2_net are required libraries to compile the examples.
14+
These can usually be install via linux package managers.
15+
More details, and instructions for Windows are included [below](#SDL2-and-SDL2_net-Install-Instructions).
16+
**NOTE:** Windows users will need to either add the DLL folders to their path, or copy the DLLs to the output directory (`Debug`).
1317

1418
### Linux / GNU Makefiles
1519

@@ -28,6 +32,9 @@ Initially generated with [xmlpg](https://github.com/open-dis/xmlpg).
2832

2933

3034
### Old Pre-make build instructions
35+
36+
* [premake5](http://premake.github.io/) is required to build the platform specific projects. Download it and make sure it's available on your path, or specify the path to it.
37+
3138
#### Linux / GNU Makefiles
3239
1. Run `premake5 gmake`
3340
1. Run `make config=release`
@@ -40,3 +47,61 @@ Initially generated with [xmlpg](https://github.com/open-dis/xmlpg).
4047
## Developer Docs
4148

4249
The latest doxygen docs for the Open DIS master branch can be found [here](https://codedocs.xyz/open-dis/open-dis-cpp/).
50+
51+
## SDL2 and SDL2_net Install Instructions
52+
53+
### Linux Package Managers
54+
55+
Arch: ```sudo pacman -S sdl2 sdl2_net```
56+
57+
Fedora: ```sudo dnf install SDL2-devel SDL2_net-devel```
58+
59+
Ubuntu: ```sudo apt-get install libsdl2-dev libsdl2-net-dev```
60+
61+
If you're unable to install the correct packages, try [installing from source](#POSIX-Source-Installation)
62+
63+
### Windows Instructions
64+
65+
These are the installation steps that have been tested with open-dis-cpp, however there are other methods for installation.
66+
Experienced users should feel free to customise their install.
67+
68+
#### (Core) SDL2 Instructions
69+
70+
1. Navigate to the SDL2 [Download](https://www.libsdl.org/download-2.0.php) page, and download the latest Development Libraries.
71+
72+
Alternatively, the version tested with open-dis-cpp, 2.0.12-VC, can be downloaded from this [direct link](https://www.libsdl.org/release/SDL2-devel-2.0.12-VC.zip).
73+
74+
2. Extract the SDL2-devel-2.0.12-VC.zip file directly to your `C:\`.
75+
3. Rename the resulting `SDL2-2.0.12` folder to `SDL2`.
76+
4. Add `C:\SDL2\lib\x64` to your System Path for 64-bit systems,
77+
or add `C:\SDL2\lib\x86` for 32-bit systems.
78+
79+
#### SDL2_net Instructions
80+
81+
1. Navigate to the SDL2_net [project](https://www.libsdl.org/projects/SDL_net/) page, and download the latest Development Libraries.
82+
83+
Alternatively, the version tested with open-dis-cpp, 2.0.1-VC, can be downloaded from this [direct link](https://www.libsdl.org/projects/SDL_net/release/SDL2_net-devel-2.0.1-VC.zip).
84+
85+
2. Extract the SDL2-devel-2.0.12-VC.zip
86+
3. Copy the `include` and `lib` directories from the resulting folder into you `C:\SDL2\` folder
87+
88+
### POSIX Source Installation
89+
90+
#### (Core) SDL2
91+
Run the following commands:
92+
1. `wget http://libsdl.org/release/SDL2-2.0.12.tar.gz`
93+
Or, Download via your favourite web browser.
94+
**NOTE:** check the [download](https://www.libsdl.org/download-2.0.php) page for new releases
95+
2. `tar -xvf SDL2-2.0.9.tar.gz`
96+
3. `pushd SDL2-2.0.9/`
97+
4. `./configure --prefix=/usr && make && sudo make install`
98+
5. `popd`
99+
100+
#### SDL2_net
101+
1. `wget https://www.libsdl.org/projects/SDL_net/release/SDL2_net-2.0.1.tar.gz`
102+
Or, Download via your favourite web browser.
103+
**NOTE:** check [https://www.libsdl.org/projects/SDL_net](project) page for new releases
104+
2. `tar -xvf SDL2_net-2.0.1.tar.gz`
105+
3. `pushd SDL2_net-2.0.1/`
106+
4. `./configure --prefix=/usr && make && sudo make install`
107+
5. `popd`

0 commit comments

Comments
 (0)