Add install/uninstall rules to Makefile

Also add a rule to generate a sample config file which during the
install process will be installed as a reference for the user

Author: pedrolucasp

.gitignore

@@ -1,3 +1,5 @@
 repos
 bin
 pkg/statik
+smithy.yml
+smithy

Makefile

@@ -1,14 +1,32 @@
 BUILD_VERSION ?= $(shell git describe --always --abbrev=40 --dirty)
 
+PREFIX?=/usr/local
+BINDIR?=$(PREFIX)/bin
+SHAREDIR?=$(PREFIX)/share/smithy
+
 LDFLAGS="-X github.com/honza/smithy/cmd.SmithyVersion=${BUILD_VERSION}"
 MODCACHE := $(shell go env GOMODCACHE)
 
 export CGO_ENABLED=0
 
-all: bin/statik
+all: smithy smithy.yml
+
+smithy: bin/statik
 	bin/statik -src=include -dest=pkg -f -m
 	go build -ldflags $(LDFLAGS) -o smithy main.go
 
+smithy.yml:
+	./smithy generate > smithy.yml
+
+install: all
+	mkdir -m755 -p $(DESTDIR)$(BINDIR) $(DESTDIR)$(SHAREDIR)
+	install -m755 smithy $(DESTDIR)$(BINDIR)/smithy
+	install -m644 smithy.yml $(DESTDIR)$(SHAREDIR)/smithy.yml
+
+uninstall: all
+	rm -r $(DESTDIR)$(BINDIR)/smithy
+	rm -fr $(DESTDIR)$(SHAREDIR)
+
 bin/statik:
 	mkdir -p bin
 	go mod download
@@ -18,5 +36,8 @@ gofmt:
 	go fmt ./pkg/... ./cmd/...
 
 clean:
-	rm smithy
+	rm smithy smithy.yml
 	rm -rf pkg/statik
+
+.PHONY:
+	smithy smithy.yml clean

README.md

@@ -30,14 +30,29 @@ $ ./smithy --help
 Installing
 -------------------------------------------------------------------------------
 
+We provide a make rule for installing/uninstall smithy. It will also install a
+sample configuration file at `/usr/local/share/smithy/smithy.yml` that you can
+later use as a guide.
+
 ```
-$ smithy generate > config.yml
-$ smithy serve --config config.yml
+$ make install
+$ make uninstall
 ```
 
 Configuration
 -------------------------------------------------------------------------------
 
+You can generate a sample configuration by issuing `make smithy.yml` command or
+directly using the smithy binary:
+
+```
+$ make smithy.yml # will generate a smithy.yml file
+$ smithy generate > config.yml
+$ smithy serve --config config.yml
+```
+
+A sample configuration can be:
+
 ``` yaml
 title: Smithy, a lightweight git forge
 description: Publish your git repositories with ease