From 30936b40dae8fbde80e8acbdf160396693573910 Mon Sep 17 00:00:00 2001 From: Alexey Lesovsky Date: Mon, 18 Mar 2019 00:16:06 +0500 Subject: [PATCH] docs: add "install from devel" mini-howto --- doc/examples.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/doc/examples.md b/doc/examples.md index bd722ab..e1f8d17 100644 --- a/doc/examples.md +++ b/doc/examples.md @@ -2,6 +2,7 @@ - [General notes](#general-notes) - [Download](#download) +- [Install devel](#install-from-dev-branch) - [Run in Docker](#run-in-docker) - [pgCenter usage](#pgcenter-usage) --- @@ -14,6 +15,24 @@ #### Download Download latest release from [release page](https://github.com/lesovsky/pgcenter/releases) and unpack, after that pgCenter is ready to run. +#### Install from dev branch +- Install fresh version of `golang` into the system. Install it with package manager or download it directly from the [official site](https://golang.org/dl/). In this case after downloading you need to unpack the archive and copy binaries into the $PATH. +- Clone pgcenter's repo, switch to `dev` branch. +``` +git clone https://github.com/lesovsky/pgcenter +cd pgcenter +git checkout --track origin/dev +``` +- Build `pgcenter` using `Makefile`. It supposes `go` binary is already is in the PATH. +``` +make +``` +- Optionally you can install `pgcenter` into `/usr/bin` using `Makefile`. Root privileges required. +``` +make install +``` +Now `pgcenter` is ready for use. + #### Run in Docker ``` docker build -t pgcenter . @@ -67,4 +86,4 @@ Full list of available parameters available in a built-in help for particular co ``` pgcenter report --help -``` \ No newline at end of file +```