14 KiB
WTF
A personal terminal-based dashboard utility, designed for displaying infrequently-needed, but very important, daily data.
Follow on Twitter for news and latest updates.
Quick Start
Download and run the latest binary or install from source:
go get -u github.com/wtfutil/wtf
cd $GOPATH/src/github.com/wtfutil/wtf
make install
make run
Note: WTF is only compatible with Go versions 1.9.2 or later. It currently does not compile with gccgo.
Documentation
See https://wtfutil.com for the definitive documentation. Here's some short-cuts:
Contributing to the Documentation
Documenation now lives in its own repository here: https://github.com/wtfutil/wtfdocs.
Please make all additions and updates to documentation in that repository.
Contributing to the Source Code
First, please read Talk, then code by Dave Cheney. It's great advice and will often save a lot of time and effort.
Next, please read 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.
Adding Dependencies
Dependency management in WTF is handled by dep. See that page for installation and usage details.
If the work you're doing requires the addition of a new dependency,
please be sure to use dep to vendor your dependencies.
Contributors
Acknowledgments
The inspiration for WTF came from Monica Dinculescu's
tiny-care-terminal.
Many thanks to Lendesk for supporting this project by providing time to develop it.
