diff options
author | Minh Nguyễn <mxn@1ec5.org> | 2015-12-24 17:19:59 -0800 |
---|---|---|
committer | Minh Nguyễn <mxn@1ec5.org> | 2016-01-05 08:04:16 -0800 |
commit | f8f735b5745051e94cf4f527a5b33b09825bc86d (patch) | |
tree | deaf202a6b0230de1fe4689a48002d5fabac558a /platform/linux/README.md | |
parent | 6af69e4e56628a7a330a7cedf9233e724bd9e344 (diff) | |
download | qtlocation-mapboxgl-f8f735b5745051e94cf4f527a5b33b09825bc86d.tar.gz |
Rewrote documentation
Rewrote some copy to provide more context and link to more GL-related repos, including GL JS. Put the various SDKs in a table so we can show the various CI bot status images.
Integrated target list into the relevant documents. Rewrote large portions of iOS and OS X setup documentation to guide normal developers to more friendly places. Combined some Android documentation.
Moved SDK-specific documentation into platform/. Added a temporary readme in ios/ that points to the one in platform/ios/.
Diffstat (limited to 'platform/linux/README.md')
-rw-r--r-- | platform/linux/README.md | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/platform/linux/README.md b/platform/linux/README.md new file mode 100644 index 0000000000..55f3e71dba --- /dev/null +++ b/platform/linux/README.md @@ -0,0 +1,54 @@ +# Linux + +A simple map application and test suite for Linux based on [Mapbox GL Native](../../README.md) and [GLFW](https://github.com/glfw/glfw). + +We are using Ubuntu for development. While the software should work on other distributions as well, we are not providing explicit build instructions here. + +This process gives you a Linux desktop app built on a Linux host system. + +### Build + +Install GCC 4.9+ if you are running Ubuntu 14.04 or older. Alternatively, you can also use [Clang 3.5+](http://llvm.org/apt/). + + sudo add-apt-repository --yes ppa:ubuntu-toolchain-r/test + sudo apt-get update + sudo apt-get install gcc-4.9 g++-4.9 + export CXX=g++-4.9 + +Ensure you have git and other build essentials: + + sudo apt-get install curl git build-essential zlib1g-dev automake \ + libtool xutils-dev make cmake pkg-config python-pip \ + libcurl4-openssl-dev libpng-dev libsqlite3-dev \ + libllvm3.4 + +Install glfw3 dependencies: + + sudo apt-get install libxi-dev libglu1-mesa-dev x11proto-randr-dev \ + x11proto-xext-dev libxrandr-dev \ + x11proto-xf86vidmode-dev libxxf86vm-dev \ + libxcursor-dev libxinerama-dev + +Set the environment variable `MAPBOX_ACCESS_TOKEN` to your [Mapbox access token](ACCESS_TOKEN.md): + + export MAPBOX_ACCESS_TOKEN=MYTOKEN + +Then, you can then proceed to build the library: + + git submodule update --init + make linux + +Set an access token as described below, and then run: + + make run-linux + +### Test + +- `make test-*` Builds and runs all tests. You can specify individual tests by replacing * with their name (e.g. `make test-Sprite.CustomSpriteImages`). + +The `zsh` will treat the * in this command as a glob, so you'll need to run +`make "test-*"` instead. + +### Usage + +Keyboard shortcuts for testing functionality are logged to the console when the test app is started. |