taigrr/wtf
1
0
Fork 0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00
Code Issues Projects Releases Wiki Activity

Merge branch 'master' of github.com:wtfutil/wtf

Browse Source
This commit is contained in:
Chris Cummer 2019-05-27 17:02:05 -07:00
commit cb9eed2b70
2 changed files with 28 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -11,7 +11,7 @@ Note that we have a code of conduct. Please follow it in all your interactions w
build.
2. Update the static documentation with details of changes to the interface, this includes new environment
variables, useful file locations and configuration parameters.
Documentation lives in the `_site` directory and is a [Hugo](https://gohugo.io) app. See Hugo's documentation for usage.
Documentation lives at [wtfdocs](https://github.com/wtfutil/wtfdocs) and is a [Hugo](https://gohugo.io) app. See Hugo's documentation for usage.
## Code of Conduct
@ -70,7 +70,7 @@ further defined and clarified by project maintainers.
### Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
reported by contacting the project owner at chriscummer@me.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.

36
README.md
View File

@ -10,15 +10,17 @@
A personal terminal-based dashboard utility, designed for
displaying infrequently-needed, but very important, daily data.
### Twitter
Follow [on Twitter](https://twitter.com/wtfutil) for news and latest updates.
### Slack
If you’re a member of the Gophers Slack community (https://invite.slack.golangbridge.org) there’s now a WTFUtil channel you should join for all your WTF questions, dev conversations, etc.
Find #wtfutil on https://gophers.slack.com/ and join us.
* [Screenshot](https://github.com/wtfutil/wtf/blob/master/README.md#screenshot)
* [Communication](https://github.com/wtfutil/wtf/blob/master/README.md#communication)
* [Slack](https://github.com/wtfutil/wtf/blob/master/README.md#slack)
* [Twitter](https://github.com/wtfutil/wtf/blob/master/README.md#twitter)
* [Quick Start](https://github.com/wtfutil/wtf/blob/master/README.md#quick-start)
* [Documentation](https://github.com/wtfutil/wtf/blob/master/README.md#documentation)
* [Contributing to the Documentation](https://github.com/wtfutil/wtf/blob/master/README.md#contributing-to-the-documentation)
* [Contributing to the Source Code](https://github.com/wtfutil/wtf/blob/master/README.md#contributing-to-the-source-code)
* [Adding Dependencies](https://github.com/wtfutil/wtf/blob/master/README.md#adding-dependencies)
* [Contributors](https://github.com/wtfutil/wtf/blob/master/README.md#contributors)
* [Acknowledgements](https://github.com/wtfutil/wtf/blob/master/README.md#acknowledgments)
## Screenshot
@ -26,6 +28,18 @@ Find #wtfutil on https://gophers.slack.com/ and join us.
<img src="./images/screenshot.jpg" title="screenshot" width="720" height="420" />
</p>
## Communication
### Slack
If you’re a member of the Gophers Slack community (https://invite.slack.golangbridge.org) there’s a WTFUtil channel you should join for all your WTF questions, development conversations, etc.
Find #wtfutil on https://gophers.slack.com/ and join us.
### Twitter
Also, follow [on Twitter](https://twitter.com/wtfutil) for news and latest updates.
## Quick Start
[Download and run the latest binary](https://github.com/wtfutil/wtf/releases) or install from source.
@ -77,7 +91,9 @@ First, please read [Talk, then code](https://dave.cheney.net/2019/02/18/talk-the
Next, please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests.
Then open your issue, propose your approach, and join the rest of the awesome people who've contributed their time and effort towards WTF. Without you it wouldn't be possible.
Then create your branch, write your code, submit your PR, and join the rest of the awesome people who've contributed their time and effort towards WTF. Without their contributors, WTF wouldn't be possible.
And don't worry if you've never written Go before, or never contributed to an open source project before, or that your code won't be good enough. For a surprising number of people WTF has been their first Go project, or first open source contribution. If you're here, and you've read this far, you're the right stuff.
### Adding Dependencies