1
0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00

First pass at new site template

This commit is contained in:
Chris Cummer
2018-08-03 05:03:26 -07:00
committed by Chris Cummer
parent 215c7e571f
commit d872a28cf7
392 changed files with 41395 additions and 222 deletions

View File

@@ -0,0 +1,52 @@
---
title: "Getting Started"
date: 2018-05-21T16:11:58-07:00
draft: false
weight: 1
---
<span style="font-family: monospace; font-size: 1.6em;">WTF</span> is a personal information dashboard for your terminal, developed for those who spend most of their day in the command line.
It allows you to monitor services and systems that you otherwise might
keep browser tabs open for, the kinds of things you don't always need
visible, but might check in on every now and then.
## Quick Start
1. <a href="https://github.com/senorprogrammer/wtf/releases">Download</a> the stand-alone, compiled binary.
2. Unzip the downloaded file.
3. From the command line, `cd` into the newly-created `/wtf` directory.
4. From the command line, run the app: `./wtf`
This should launch the app in your terminal using the default simple
configuration. See <a href="/posts/configuration/">Configuration</a> for
more details.
## Command-line Options
`--config, -c` <br />
Allows you to define a custom config file to use. See <a href="/posts/configuration/">Configuration</a> for more details.
`--help, -h` <br />
Shows help information for the command-line arguments that WTF
takes.
`--module, -m` <br />
Shows help information for the specific named module, if that module
supports help text. <br />
Example: `wtf --module=todo`.
`--version, -v` <br />
Shows version info.
## Keyboard Commands
<span class="caption">Key:</span> `Ctrl-R` <br />
<span class="caption">Action:</span> Force-refresh the data for all modules.
<span class="caption">Key:</span> `Esc` <br />
<span class="caption">Action:</span> Unfocus the currently-focused
widget.
<span class="caption">Key:</span> `Tab` <br />
<span class="caption">Action:</span> Move between focusable modules (`Shift-Tab` to move backwards).

View File

@@ -0,0 +1,17 @@
---
title: "Glossary"
date: 2018-04-17T12:34:51-07:00
draft: false
---
### Module
A discreet unit of data collection and display. A data interface
concept. A package inside the app.
Examples: New Relic, Git, Weather.
### Widget
The onscreen representation of a Module. The widget is responsible for
being the interface between the app and the data collection.
Widgets are defined by a required `widget.go` file in a Module.

View File

@@ -0,0 +1,34 @@
---
title: "Installation"
date: 2018-05-18T09:59:40-07:00
draft: false
---
## As a Binary
Grab the latest version from here:
```bash
https://github.com/senorprogrammer/wtf/releases
```
expand it, and `cd` into the resulting directory. Then run:
```bash
./wtf
```
and that should also do it.
## From Source
Download the source code repo and install the dependencies:
```bash
go get -u github.com/senorprogrammer/wtf
cd $GOPATH/src/github.com/senorprogrammer/wtf
go install -ldflags="-s -w"
make run
```
and that should do it.