From e730281003b4a4caad0d48c2712e5d1433848bd7 Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Mon, 20 Apr 2015 17:05:33 +0200 Subject: [PATCH] fix(docker): README info + fix author email Please note that docker build script is still in debug mode, this issue will remind me about it: #72 Fixes #71 --- .docker-build-cli.sh | 1 + README.md | 18 ++++++++++++++++++ etc/api/shared.yaml | 2 +- 3 files changed, 20 insertions(+), 1 deletion(-) diff --git a/.docker-build-cli.sh b/.docker-build-cli.sh index 10a0648d83a..454cd097e5c 100755 --- a/.docker-build-cli.sh +++ b/.docker-build-cli.sh @@ -1,5 +1,6 @@ #!/bin/sh # For execution on docker build image only ! # make cargo-cli ARGS="build --release" +# DEBUG: only try to build a small CLI for now make discovery1-cli-cargo ARGS="build --release" find gen -executable -type f -path "*/release/*" -not \( -name "*.*" -or -name "*script*" \) | xargs cp -v /build-result \ No newline at end of file diff --git a/README.md b/README.md index a6ca0cb007b..63c548c52aa 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,24 @@ For example, to update all json files and possibly retrieve new API schemas, do rm -f .api.deps .cli.deps && make update-json -j8 ``` +## Cross Platform Compilation + +This is still a difficult topic in Rust, and even though in theory it's possible to do that on a single system without virutalization, it's difficult to achieve when you are not a pure Rust program. Therefore using VMs is the only option, and we are trying to make this as easy as possible. + +### Linux AMD-64 from OSX + +This setup is based on Docker, which comes with a *virtual-box*-based linux VM. To use it, just install [boot2docker](http://boot2docker.io/). + +The following commands should do the job: + +```bash +boot2docker up +# export listed variables to prepare your shell +make wheezy-build +``` + +You will find your *release* build in the *build/* subdirectory of the project's root. + # License The license of everything not explicitly under a different license are licensed as specified in `LICENSE.md`. diff --git a/etc/api/shared.yaml b/etc/api/shared.yaml index 4a6a1f6cffe..c7908f823df 100644 --- a/etc/api/shared.yaml +++ b/etc/api/shared.yaml @@ -25,7 +25,7 @@ cargo: doc_base_url: http://byron.github.io/google-apis-rs authors: # don't forget to possibly add them to copyright authors - - Sebastian Thiel + - Sebastian Thiel keywords: [google] # All APIs should live in the same repository repository_url: https://github.com/Byron/google-apis-rs