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
This commit is contained in:
Felix Lange 2015-04-18 23:21:45 +02:00
parent 84f1af6413
commit 48f23746f0
3 changed files with 55 additions and 0 deletions

5
.gitignore vendored
View File

@ -27,3 +27,8 @@ mist
cmd/mist/mist cmd/mist/mist
deploy/osx/Mist.app deploy/osx/Mist.app
deploy/osx/Mist\ Installer.dmg deploy/osx/Mist\ Installer.dmg
# used by the Makefile
/build/_workspace/
/build/bin/

22
Makefile Normal file
View File

@ -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)/*

28
build/env.sh Executable file
View File

@ -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 $@