Merge pull request #412 from slingamn/make.3

fix #409

.travis.yml

@@ -3,10 +3,6 @@ language: go
 go:
     - "1.11.x"
 
-install: make deps
-
 script:
-- wget https://github.com/goreleaser/goreleaser/releases/download/v0.62.2/goreleaser_Linux_x86_64.tar.gz
-- tar -xzf goreleaser_Linux_x86_64.tar.gz -C $GOPATH/bin
 - make
 - make test

DEVELOPING.md

@@ -2,6 +2,13 @@
 
 This is just a bunch of tips and tricks we keep in mind while developing Oragono. If you wanna help develop as well, they might also be worth keeping in mind!
 
+## Golang issues
+
+You should use the [latest distribution of the Go language for your OS and architecture](https://golang.org/dl/). (If `uname -m` on your Raspberry Pi reports `armv7l`, use the `armv6l` distribution of Go; if it reports v8, you may be able to use the `arm64` distribution.)
+
+Oragono vendors all its dependencies. The vendored code is tracked via a git submodule: `vendor/` is a submodule pointing to the [oragono-vendor](https://github.com/oragono/oragono-vendor) repository. As long as you're not modifying the vendored dependencies, `make` should take care of everything for you --- but if you are, see the "vendor" section below.
+
+Because of this, Oragono is self-contained and you should not need to fetch any dependencies with `go get`. Doing so is not recommended, since it may fetch incompatible versions of the dependencies. If you're having trouble building the code, it's very likely because your clone of the repository is in the wrong place: Go is very opinionated about where you should keep your code. Take a look at the [go workspaces documentation](https://golang.org/doc/code.html) if you're having trouble.
 
 ## Branches
 
@@ -21,7 +28,7 @@ Develop branches are either used to work out implementation details in preperati
 5. Remove unused sections from the changelog, change the date/version number and write release notes.
 6. Commit the new changelog and constants change.
 7. Tag the release with `git tag v0.0.0 -m "Release v0.0.0"` (`0.0.0` replaced with the real ver number).
-8. Build binaries using the Makefile, upload release to Github including the changelog and binaries.
+8. Build binaries using `make release`, upload release to Github including the changelog and binaries.
 9. If it's a proper release (i.e. not an alpha/beta), merge the updates into the `stable` branch.
 
 Once it's built and released, you need to setup the new development version. To do so:

Makefile

@@ -1,13 +1,13 @@
-.PHONY: all build
+.PHONY: all install release capdefs deps test
 
 capdef_file = ./irc/caps/defs.go
 
-all: build
+all: install
 
-build:
+install: deps
-	goreleaser --snapshot --rm-dist
+	./install.sh
 
-buildrelease:
+release:
 	goreleaser --skip-publish --rm-dist
 
 capdefs:

README.md

@@ -70,21 +70,19 @@ The `stable` branch contains the latest release. You can run this for a producti
 
 #### Building
 
-Clone the appropriate branch. You should also run this command to set up vendored dependencies:
+You'll need an [up-to-date distribution of the Go language for your OS and architecture](https://golang.org/dl/). You'll also need to set up a [Go workspace](https://golang.org/doc/code.html). Typically, this is just a directory `~/go`, with the `GOPATH` environment variable exported to its path with `export GOPATH=~/go`.
-```
-git submodule update --init
-```
 
-From the root folder, you can run `make`, using [GoReleaser](https://goreleaser.com/) to generate all of our release binaries in `/dist`:
+Clone the repository where `go` expects it to be and then run `make`, i.e.,
-```
+
+```bash
+mkdir -p ${GOPATH}/src/github.com/oragono
+cd ${GOPATH}/src/github.com/oragono
+git clone https://github.com/oragono/oragono
+cd oragono
+# check out the appropriate branch if necessary
+# now, this will install a development copy of oragono at ${GOPATH}/bin/oragono:
 make
-```
+````
-
-However, when just developing I instead just use this command to rebuild and run Oragono on the fly with the latest changes:
-```
-go run oragono.go
-```
-
 
 ## Configuration
 

install.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+set -e
+
+if [ -z "$GOPATH" ]; then
+	echo Error: \$GOPATH is unset
+	echo See https://golang.org/doc/code.html for details, or try these steps:
+	echo -e "\tmkdir -p ~/go"
+	echo -e "\texport GOPATH=~/go"
+	exit 1
+fi
+
+EXPECTED_DIR=${GOPATH}/src/github.com/oragono/oragono
+
+if [ "$PWD" != "$EXPECTED_DIR" ] ; then
+	echo Error: working directory is not where \$GOPATH expects it to be
+	echo "Expected: $EXPECTED_DIR"
+	echo "Actual:   $PWD"
+	echo See https://golang.org/doc/code.html for details, or try these steps:
+	echo -e "\tmkdir -p ${GOPATH}/src/github.com/oragono"
+	echo -e "\tcd ${GOPATH}/src/github.com/oragono"
+	echo -e "\tmv $PWD oragono"
+	echo -e "\tcd oragono"
+	exit 1
+fi
+
+go install -v
+echo successfully installed as ${GOPATH}/bin/oragono