From 4fdcf5a090cc87fdde3bb4ff8200254cdfb69e60 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philipp=20H=C3=A4felfinger?= Date: Thu, 21 Mar 2019 22:37:32 +0100 Subject: [PATCH] updated readme with the part about dependencies and mocks --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index 8256482..2c6c00d 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,27 @@ There are some features planned but not ready yet: To get the latest version, you should check out https://git.haefelfinger.net/piwigo/PiwigoDirectoryUploader.git to your local go source directory. +### Dependencies + +There are some external dependencies to build the application. + +- logrus: This is a little logging library that is quite handy +- iniflags: The iniflags makes handling configuration files and applications parameters quite easy. + +You may install these manually with the following commands or just use the command under "Build" to get all dependencies. + +``` +go get github.com/sirupsen/logrus +go get github.com/vharitonsky/iniflags +``` + +To build the mocks there are two go:generate dependencies: + +``` +go get github.com/golang/mock/gomock +go get github.com/golang/mock/mockgen +``` + ### Build Get all dependencies first. @@ -45,6 +66,12 @@ can be renamed to your favorite application name. go build cmd/PiwigoDirectoryUploader/PiwigoDirectoryUploader.go ``` +To rebuild the mocks you can simply use the following command: + +``` +go generate ./... +``` + ### Configuration #### Command line