From 5834e066f369818de7b3d99377f679d52feb2cf2 Mon Sep 17 00:00:00 2001 From: "Wyatt J. Miller" Date: Sun, 29 Sep 2019 19:29:13 -0400 Subject: [PATCH] Update README.md --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 04b9c32..97b30af 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # logman Collecting log files for the greater good! -This program lets you grab log files (or any file if you wanted to) remotely and store them up into a compressed file on your local machine! +This program lets you grab log files remotely and store them up into a compressed file on your local machine! + +In all reality, you can literally grab any file you wish to grab of any remote machine. ## Installation @@ -17,12 +19,20 @@ Before you start the program, I would like to highlight the attraction to said p The configuration file, `config.yaml`, is where you set everything about where you want to grab logs from. +To run the `logman` program: + +`go run .` in the root directory of the project. + +To build the `logman` program: + +`go build .` and then a binary will appear in the `bin` directory of your `$GOPATH`. + After that, just run the binary and you should be golden. ## Troubleshooting -The GitHub issue board is where I post issues with the program. If you any issue with the program, please post it there. +The GitHub issue board is where I post issues with the program. If you any issue with the program, please post it there. Go panics are a great example of an issue you can post. I'm new to Go, so forgive the long wait time for any bux fix. ## Contributing -If you would like to contribute, feel free to email me or send in pull requests. `todo.md` should have some things to get you rolling. +If you would like to contribute, feel free to email me or send in pull requests. `todo.md` should have some things to get you rolling. There's quite a few items on there that I want added to make `logman` a finished product.