diff --git a/_site/content/posts/overview.md b/_site/content/posts/overview.md index 0eeafa4c..0ada7fb5 100644 --- a/_site/content/posts/overview.md +++ b/_site/content/posts/overview.md @@ -10,14 +10,16 @@ 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. -Download it as a stand-alone, compiled binary, or install it from source. +## Quick Start -Once installed, edit your configuration file and define the -modules you want to run. +1. Download 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` -Configuration instructions for each module can be found in the module -pages, listed at left. +This should launch the app in your terminal using the default simple +configuration. See Configuration for +more details. ## Command-line Options diff --git a/dist/CHANGELOG.md b/dist/CHANGELOG.md new file mode 100644 index 00000000..f39e40aa --- /dev/null +++ b/dist/CHANGELOG.md @@ -0,0 +1,23 @@ +## Changelog + +f23ac85 Fixes bug with default configuration YAML +3e004fd Fix a speling mistake in the documentation +641dce9 Add Configuration and Keyboard Commands to Overview documentation. +ff49ecb Closes #29. wtf.go --help [module name] returns help text if any is available. +9e9ef93 Update the readme +38cf1d5 Security module now displays logged-in users +efaccc8 Added Overview page to documentation +5d66b2a Improve the state of the Makefile a bit +ca4d6f2 Add 'make dependencies' to the Makefile +cd5a796 Fix bug with positioning in which I hard-coded the positions because....? +374832f Update the readme +ca81908 Add dramatic marketing emphasis to site homepage +216a313 Clean up the site sideabar +8bb9115 A very basic start to adding some unit tests +c190a44 Updated the screenshot to show all the modules +e2c27ab Add installation instructions to documentation +ca7d867 h2 styling in the site +0d1c9ca Add documentation for CmdRunner +a62b910 Closes #43. Add CommandRunner module to the app. +c3f1402 WIP +a6dce55 Update the doc site diff --git a/dist/config.yaml b/dist/config.yaml new file mode 100644 index 00000000..4867485a --- /dev/null +++ b/dist/config.yaml @@ -0,0 +1,73 @@ +project_name: wtf +release: + github: + owner: senorprogrammer + name: wtf + name_template: '{{.Tag}}' +brew: + name: wtf + commit_author: + name: goreleaserbot + email: goreleaser@carlosbecker.com + install: bin.install "wtf" +scoop: + commit_author: + name: goreleaserbot + email: goreleaser@carlosbecker.com +builds: +- goos: + - darwin + - linux + goarch: + - amd64 + goarm: + - "6" + targets: + - darwin_amd64 + - linux_amd64 + main: . + ldflags: + - -s -w -X main.version={{.Version}} -X main.commit={{.Commit}} -X main.date={{.Date}} + binary: wtf + lang: go +archive: + name_template: '{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ if .Arm + }}v{{ .Arm }}{{ end }}' + format: tar.gz + files: + - licence* + - LICENCE* + - license* + - LICENSE* + - readme* + - README* + - changelog* + - CHANGELOG* +nfpm: + name_template: '{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ if .Arm + }}v{{ .Arm }}{{ end }}' + bindir: /usr/local/bin +snapcraft: + name_template: '{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ if .Arm + }}v{{ .Arm }}{{ end }}' +snapshot: + name_template: SNAPSHOT-{{ .Commit }} +checksum: + name_template: '{{ .ProjectName }}_{{ .Version }}_checksums.txt' +dist: dist +sign: + cmd: gpg + args: + - --output + - $signature + - --detach-sig + - $artifact + signature: ${artifact}.sig + artifacts: none +env_files: + github_token: ~/.config/goreleaser/github_token +before: + hooks: + - make install +github_urls: + download: https://github.com diff --git a/dist/darwin_amd64/wtf b/dist/darwin_amd64/wtf new file mode 100755 index 00000000..eac12e4b Binary files /dev/null and b/dist/darwin_amd64/wtf differ diff --git a/dist/linux_amd64/wtf b/dist/linux_amd64/wtf new file mode 100755 index 00000000..cef0d13b Binary files /dev/null and b/dist/linux_amd64/wtf differ diff --git a/dist/wtf_0.0.3_checksums.txt b/dist/wtf_0.0.3_checksums.txt new file mode 100644 index 00000000..f88d94a2 --- /dev/null +++ b/dist/wtf_0.0.3_checksums.txt @@ -0,0 +1,2 @@ +0167b691f57126d3a5cd6ffb4a6ba6115a9b3c5a48541db370530761400b9a21 wtf_0.0.3_linux_amd64.tar.gz +9905629c87fef6c3483bbdd1f8fcf69f4821da9aa80f05b22a8162a063c7905f wtf_0.0.3_darwin_amd64.tar.gz diff --git a/dist/wtf_0.0.3_darwin_amd64.tar.gz b/dist/wtf_0.0.3_darwin_amd64.tar.gz new file mode 100644 index 00000000..114b8c76 Binary files /dev/null and b/dist/wtf_0.0.3_darwin_amd64.tar.gz differ diff --git a/dist/wtf_0.0.3_linux_amd64.tar.gz b/dist/wtf_0.0.3_linux_amd64.tar.gz new file mode 100644 index 00000000..e9fee4d2 Binary files /dev/null and b/dist/wtf_0.0.3_linux_amd64.tar.gz differ diff --git a/docs/index.xml b/docs/index.xml index 05e8472f..4a5c20d8 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -19,7 +19,7 @@ http://wtfutil.com/posts/overview/ WTF 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. -Download it as a stand-alone, compiled binary, or install it from source. +Quick Start Download the stand-alone, compiled binary. Unzip the downloaded file. From the command line, cd into the newly-created /wtf directory. diff --git a/docs/posts/index.xml b/docs/posts/index.xml index 2fb198d9..d58e132c 100644 --- a/docs/posts/index.xml +++ b/docs/posts/index.xml @@ -19,7 +19,7 @@ http://wtfutil.com/posts/overview/ WTF 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. -Download it as a stand-alone, compiled binary, or install it from source. +Quick Start Download the stand-alone, compiled binary. Unzip the downloaded file. From the command line, cd into the newly-created /wtf directory. diff --git a/docs/posts/overview/index.html b/docs/posts/overview/index.html index 621b89fd..0f5bad63 100644 --- a/docs/posts/overview/index.html +++ b/docs/posts/overview/index.html @@ -113,14 +113,18 @@ keep browser tabs open for, the kinds of things you don’t always need visible, but might check in on every now and then.

-

Download it as a stand-alone, compiled binary, or install it from source.

+

Quick Start

-

Once installed, edit your configuration file and define the -modules you want to run.

+
    +
  1. Download the stand-alone, compiled binary.
    2. +
  2. Unzip the downloaded file.
    3. +
  3. From the command line, cd into the newly-created /wtf directory.
    4. +
  4. From the command line, run the app: ./wtf
    5. +
-

Configuration instructions for each module can be found in the module -pages, listed at left.

+

This should launch the app in your terminal using the default simple +configuration. See Configuration for +more details.

Command-line Options