README.md

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:

• Installation
• Configuration
• Module Documentation

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

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

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

Thanks go to these wonderful people for contributing back to this project:

Chris Cummer

Anand Sudhir Prayaga

Hossein Mehrabi

FengYa

deltax

Bill Keenan

June S

liyiheng

baustinanki

lucus lee

Mike Lloyd

Sergio Rubio

Farhad Farahi

Lasantha Kularatne

Mark Old

flw

David Barda

Geoff Lee

George Opritescu

Grazfather

Michael Cordell

Patrick José Pereira

sherod taylor

Andrew Scott

Lassi Piironen

BlackWebWolf

andrewzolotukhin

Leon Stigter

Amr Tamimi

Jagdeep Singh

Lineu Felipe

Konstantin

Brendan O'Leary

bertl4398

Ferenc-

Rohan Verma

Tim Fitzgerald

Federico Ruggi

Craig Woodward

ReadmeCritic

Eugene

Kenny Wu

Renán Romero

Bastian Groß

nicholas-eden

Dan Rabinowitz

David Missmann

Mathias Weber

TheRedSpy15

Harald Nordgren

Matei Alexandru Gardus

Sean Smith

Halil Kaskavalci

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.