wtf

README

WTF

A personal terminal-based dashboard utility, designed for displaying infrequently-needed, but very important, daily data.

• Screenshot
• Communication
  • Slack
  • Twitter
• Quick Start
• Documentation
  • Contributing to the Documentation
• Contributing to the Source Code
  • Adding Dependencies
• Contributors
• Acknowledgements

Screenshot

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 for news and latest updates.

Quick Start

Download and run the latest binary or install from source.

If you want to run the build command from within your $GOPATH:

# Set the Go proxy variable to GoCenter
export GOPROXY="https://gocenter.io"
# Enable Go modules
export GO111MODULE=on
go get -u github.com/wtfutil/wtf
cd $GOPATH/src/github.com/wtfutil/wtf
make install
make run

If you want to run the build command from a folder that is not in your $GOPATH:

# Set the Go proxy variable to GoCenter
export GOPROXY="https://gocenter.io"
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.11.0 or later (due to the use of Go modules). 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

Documentation 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 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

Dependency management in WTF is handled by Go modules. Please check out that page for more details on how Go modules work.

Contributors

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	Johan Denoyer	Jelle Vink	Devin Collins
Danne Stayskal	Max Beizer	E:V:A	Gabriel	Andrew Scibek	FriedCosey	Michele Gerarduzzi
Jack Morris	foorb	Levi Baber	Graham Anderson	Romain Bossart	Kirill Motkov	Brian Choromanski
Sean DuBois

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.