From d2c836272937a3056bed4864c6fbdea5f47139e5 Mon Sep 17 00:00:00 2001 From: Dominic Breuker Date: Sat, 9 Jun 2018 22:51:00 +0200 Subject: [PATCH] add download links to readme --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5f135e1..fcd5dc6 100644 --- a/README.md +++ b/README.md @@ -18,16 +18,19 @@ Inotify watchers placed on selected parts of the file system trigger these scans ## Getting started Get the tool onto the Linux machine you want to inspect. -First get the binaries. +First get the binaries. Download the released binaries here: +- 32 bit big, static version: `pspy32` [download](https://github.com/DominicBreuker/pspy/releases/download/v1.0.0/pspy32) +- 64 bit big, static version: `pspy64` [download](https://github.com/DominicBreuker/pspy/releases/download/v1.0.0/pspy64) +- 32 bit small version: `pspy32s` [download](https://github.com/DominicBreuker/pspy/releases/download/v1.0.0/pspy32s) +- 64 bit small version: `pspy64s` [download](https://github.com/DominicBreuker/pspy/releases/download/v1.0.0/pspy64s) -You can build them yourself by running `make build-build-image` to build a docker image used in `make build` to build four binaries: -- 32 bit big, static version: `pspy32` -- 64 bit big, static version: `pspy64` -- 32 bit small version: `pspy32s` -- 64 bit small version: `pspy64s` The statically compiled files should work on any Linux system but are quite huge (~4MB). If size is an issue, try the smaller versions which depend on libc and are compressed with UPX (<1MB). +Alternatively, build the binaries yourself. +Either use Go installed on your system or run the Docker-based build process which ran to create the release. +For the latter, ensure Docker is installed, and then run `make build-build-image` to build a Docker image, followed by `make build` to build the binaries with it. + You can run `pspy --help` to learn about the flags and their meaning. The summary is as follows: - -p: enables printing commands to stdout (enabled by default)