From 48f23746f0f92887b6a76055e8f16c28176bc181 Mon Sep 17 00:00:00 2001 From: Felix Lange Date: Sat, 18 Apr 2015 23:21:45 +0200 Subject: [PATCH] Makefile: for non-gophers Many people need or want to build go-ethereum from the git repository, mostly to stay up to date with recent changes. We cannot expect that people without Go experience grok the Go workspace concept. With the Makefile, building from github requires only three steps (provided that a Go toolchain is installed): - git clone https://github.com/ethereum/go-ethereum - ... install C libraries (libgmp, etc.) ... - make --- .gitignore | 5 +++++ Makefile | 22 ++++++++++++++++++++++ build/env.sh | 28 ++++++++++++++++++++++++++++ 3 files changed, 55 insertions(+) create mode 100644 Makefile create mode 100755 build/env.sh diff --git a/.gitignore b/.gitignore index e72867f287..43061642a6 100644 --- a/.gitignore +++ b/.gitignore @@ -27,3 +27,8 @@ mist cmd/mist/mist deploy/osx/Mist.app deploy/osx/Mist\ Installer.dmg + +# used by the Makefile +/build/_workspace/ +/build/bin/ + diff --git a/Makefile b/Makefile new file mode 100644 index 0000000000..1fdc36f98e --- /dev/null +++ b/Makefile @@ -0,0 +1,22 @@ +# This Makefile is meant to be used by people that do not usually work +# with Go source code. If you know what GOPATH is then you probably +# don't need to bother with make. +# +# Note that there is no way to run the tests or do anything other than +# building the binaries. This is by design. + +.PHONY: geth mist clean +GOBIN = build/bin + +geth: + build/env.sh go install -v github.com/ethereum/go-ethereum/cmd/geth + @echo "Done building." + @echo "Run \"$(GOBIN)/geth\" to launch geth." + +mist: + build/env.sh go install -v github.com/ethereum/go-ethereum/cmd/mist + @echo "Done building." + @echo "Run \"$(GOBIN)/mist --asset_path=cmd/mist/assets\" to launch mist." + +clean: + rm -fr build/_workspace/pkg/ $(GOBIN)/* diff --git a/build/env.sh b/build/env.sh new file mode 100755 index 0000000000..b28ad6259d --- /dev/null +++ b/build/env.sh @@ -0,0 +1,28 @@ +#!/bin/sh + +set -e + +if [ ! -f "build/env.sh" ]; then + echo "$0 must be run from the root of the repository." + exit 2 +fi + +# Create fake Go workspace if it doesn't exist yet. +workspace="$PWD/build/_workspace" +root="$PWD" +ethdir="$workspace/src/github.com/ethereum" +if [ ! -L "$ethdir/go-ethereum" ]; then + mkdir -p "$ethdir" + cd "$ethdir" + ln -s ../../../../../. go-ethereum + cd "$root" +fi + +# Set up the environment to use the workspace. +# Also add Godeps workspace so we build using canned dependencies. +GOPATH="$ethdir/go-ethereum/Godeps/_workspace:$workspace" +GOBIN="$PWD/build/bin" +export GOPATH GOBIN + +# Launch the arguments with the configured environment. +exec $@