Skip to content

steve-winter/wtf

 
 

Repository files navigation

All Contributors Build Status Gitter Chat Twitter Go Report Card

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

Chris Cummer
Chris Cummer

Anand Sudhir Prayaga
Anand Sudhir Prayaga

Hossein Mehrabi
Hossein Mehrabi

FengYa
FengYa

deltax
deltax

Bill Keenan
Bill Keenan

June S
June S

liyiheng
liyiheng

baustinanki
baustinanki

lucus lee
lucus lee

Mike Lloyd
Mike Lloyd

Sergio Rubio
Sergio Rubio

Farhad Farahi
Farhad Farahi

Lasantha Kularatne
Lasantha Kularatne

Mark Old
Mark Old

flw
flw

David Barda
David Barda

Geoff Lee
Geoff Lee

George Opritescu
George Opritescu

Grazfather
Grazfather

Michael Cordell
Michael Cordell

Patrick José Pereira
Patrick José Pereira

sherod taylor
sherod taylor

Andrew Scott
Andrew Scott

Lassi Piironen
Lassi Piironen

BlackWebWolf
BlackWebWolf

andrewzolotukhin
andrewzolotukhin

Leon Stigter
Leon Stigter

Amr Tamimi
Amr Tamimi

Jagdeep Singh
Jagdeep Singh

Lineu Felipe
Lineu Felipe

Konstantin
Konstantin

Brendan O'Leary
Brendan O'Leary

bertl4398
bertl4398

Ferenc-
Ferenc-

Rohan Verma
Rohan Verma

Tim Fitzgerald
Tim Fitzgerald

Federico Ruggi
Federico Ruggi

Craig Woodward
Craig Woodward

ReadmeCritic
ReadmeCritic

Eugene
Eugene

Kenny Wu
Kenny Wu

Renán Romero
Renán Romero

Bastian Groß
Bastian Groß

nicholas-eden
nicholas-eden

Dan Rabinowitz
Dan Rabinowitz

David Missmann
David Missmann

Mathias Weber
Mathias Weber

TheRedSpy15
TheRedSpy15

Harald Nordgren
Harald Nordgren

Matei Alexandru Gardus
Matei Alexandru Gardus

Sean Smith
Sean Smith

Halil Kaskavalci
Halil Kaskavalci

Johan Denoyer
Johan Denoyer

Jelle Vink
Jelle Vink

Devin Collins
Devin Collins

Danne Stayskal
Danne Stayskal

Max Beizer
Max Beizer

E:V:A
E:V:A

Gabriel
Gabriel

Andrew Scibek
Andrew Scibek

FriedCosey
FriedCosey

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.

About

The personal information dashboard for your terminal.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 99.2%
  • Other 0.8%