From bf1993467b1257e8ecd328d450590819b01ed796 Mon Sep 17 00:00:00 2001 From: Michael Whatcott Date: Mon, 14 Aug 2017 12:56:06 -0600 Subject: [PATCH] Full instructions for compiling and executing. --- .gitignore | 1 + Makefile | 21 +++++++++++++++++++++ README.md | 10 ++++++++++ 3 files changed, 32 insertions(+) create mode 100755 Makefile diff --git a/.gitignore b/.gitignore index 78237ac..31be9d7 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ .idea +bin* smartyping.test smartyping.test.exe diff --git a/Makefile b/Makefile new file mode 100755 index 0000000..61078df --- /dev/null +++ b/Makefile @@ -0,0 +1,21 @@ +#!/usr/bin/make -f + +compress: compile + zip -r 'bin-$(shell git describe).zip' ./bin + +compile: prepare + GOOS=darwin go test -c -o ./bin/macos/smartyping + GOOS=linux GOARCH=386 go test -c -o ./bin/linux-386/smartyping + GOOS=linux GOARCH=amd64 go test -c -o ./bin/linux-amd64/smartyping + GOOS=windows GOARCH=386 go test -c -o ./bin/windows-386/smartyping + GOOS=windows GOARCH=amd64 go test -c -o ./bin/windows-amd64/smartyping + +prepare: clean + mkdir -p ./bin/macos + mkdir -p ./bin/linux-386 + mkdir -p ./bin/linux-amd64 + mkdir -p ./bin/windows-386 + mkdir -p ./bin/windows-amd64 + +clean: + rm -rf ./bin* diff --git a/README.md b/README.md index 4c902e5..68b4945 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,13 @@ $ go get github.com/smartystreets/smartyping $ cd $GOPATH/src/github.com/smartystreets/smartyping $ go test -v ``` + +To execute a [release binary](https://github.com/smartystreets/smartyping/releases): + +Unzip the archive and navigate to the directory matching your platform. Then run one of the following commands: + +$ smartyping + +To execute in verbose mode: + +$ smartyping -test.v \ No newline at end of file