Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add proper informations about Docker build. May close #119 #120

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add proper informations about Docker build. May close #119 #120

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ If you want to build against system libraries, the following packages are necess

### Linux:

* GCC/G++ (version 6+ is recommend)
* GCC/G++ (version 6+ is recommend, but 10 is currently not supported: https://github.com/GrangerHub/tremulous/issues/119)
* CMake (Optional)
* CURL (for downloading assets)
* rsync (for asset management)
Expand Down Expand Up @@ -57,6 +57,24 @@ Currently there is no native Windows build setup, all builds are cross compiled

TBD

### Cross Platform build and debug on UNIX

Since some dependencies as GCC<=9 may be hard to install, you may prefer build using Docker.

```bash
git clone https://github.com/GrangerHub/tremulous.git
cd tremulous
docker run -ti -e PLATFOTM=CHOOSE_PLATFORM_HERE -v $(pwd):/usr/src grangerhub/tremulous13:latest ./misc/docker-build.sh
```

See other possible `PLATFORM` values as `linux` and `mingw32` in `Makefile` file. Default to running env (which is Linux while using Docker).

An other advanced build example could be:
```bash
docker run -ti -e USE_RESTCLIENT=1 -e USE_INTERNAL_LUA=1 -v $(pwd):/usr/src grangerhub/tremulous13:latest make debug
```
which will include debug symbols for use in debug software like `gdb`.

## How to Install from the Source Code

For Linux and Mac OS X builds, follow these steps.
Expand Down