wymiller/logman
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Wyatt J. Miller 2019-09-29 19:29:13 -04:00 committed by GitHub
parent aadc4f0790
commit 5834e066f3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -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.