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

Merge pull request #64 from matrinox/fix-setup-docs

Fix instructions
This commit is contained in:
Chris Cummer 2018-05-28 16:09:05 -07:00 committed by GitHub
commit 10ed6b0aea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 11 additions and 13 deletions

View File

@ -101,7 +101,7 @@ wtf:
rows: rows:
even: "lightblue" even: "lightblue"
odd: "white" odd: "white"
domain: "https://lendesk.atlassian.net" domain: "https://company.atlassian.net"
enabled: true enabled: true
position: position:
top: 1 top: 1

View File

@ -12,8 +12,7 @@ Get this repo and install the dependencies:
```bash ```bash
go get github.com/senorprogrammer/wtf go get github.com/senorprogrammer/wtf
cd $GOPATH/github.com/senorprogrammer/wtf cd $GOPATH/src/github.com/senorprogrammer/wtf
go get ./...
make install make install
make run make run
``` ```

View File

@ -63,7 +63,7 @@ git:
refreshInterval: 8 refreshInterval: 8
repositories: repositories:
- "/Users/chris/go/src/github.com/senorprogrammer/wtf" - "/Users/chris/go/src/github.com/senorprogrammer/wtf"
- "/Users/chris/Documents/Lendesk/fakeapp" - "/Users/user/fakeapp"
``` ```
### Attributes ### Attributes

View File

@ -39,7 +39,7 @@ jira:
left: 1 left: 1
height: 1 height: 1
width: 2 width: 2
project: "CORE" project: "JIRA"
refreshInterval: 900 refreshInterval: 900
username: "chris.cummer" username: "chris.cummer"
``` ```

View File

@ -56,7 +56,7 @@ Quick Start Download the stand-alone, compiled binary. Unzip the downloaded fil
<guid>http://wtfutil.com/posts/installation/</guid> <guid>http://wtfutil.com/posts/installation/</guid>
<description>There are two ways to install WTF: <description>There are two ways to install WTF:
From Source Get this repo and install the dependencies: From Source Get this repo and install the dependencies:
go get github.com/senorprogrammer/wtf cd $GOPATH/github.com/senorprogrammer/wtf go get ./... make install make run and that should probably do it. go get github.com/senorprogrammer/wtf cd $GOPATH/src/github.com/senorprogrammer/wtf make install make run and that should probably do it.
As a Binary Grab the latest version from here: As a Binary Grab the latest version from here:
https://github.com/senorprogrammer/wtf/releases expand it, and cd into the resulting directory. Then run: https://github.com/senorprogrammer/wtf/releases expand it, and cd into the resulting directory. Then run:
./wtf and that should also do it.</description> ./wtf and that should also do it.</description>
@ -108,7 +108,7 @@ Key: j Action: Select the next item in the list.</description>
<description>Displays all Jira issues assigned to you for the specified project. <description>Displays all Jira issues assigned to you for the specified project.
Source Code wtf/jira/ Required ENV Variables Key: WTF_JIRA_API_KEY Value: Your Jira API key. Source Code wtf/jira/ Required ENV Variables Key: WTF_JIRA_API_KEY Value: Your Jira API key.
Keyboard Commands None. Keyboard Commands None.
Configuration jira:colors:rows:even:&amp;#34;lightblue&amp;#34;odd:&amp;#34;white&amp;#34;domain:&amp;#34;https://umbrellacorp.atlassian.net&amp;#34;email:&amp;#34;chriscummer@me.com&amp;#34;enabled:trueposition:top:4left:1height:1width:2project:&amp;#34;CORE&amp;#34;refreshInterval:900username:&amp;#34;chris.cummer&amp;#34; Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name. Configuration jira:colors:rows:even:&amp;#34;lightblue&amp;#34;odd:&amp;#34;white&amp;#34;domain:&amp;#34;https://umbrellacorp.atlassian.net&amp;#34;email:&amp;#34;chriscummer@me.com&amp;#34;enabled:trueposition:top:4left:1height:1width:2project:&amp;#34;JIRA&amp;#34;refreshInterval:900username:&amp;#34;chris.cummer&amp;#34; Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name.
colors.rows.odd Define the foreground color for odd-numbered rows. Values: Any X11 color name. colors.rows.odd Define the foreground color for odd-numbered rows. Values: Any X11 color name.
domain Your Jira corporate domain. Values: A valid URI. domain Your Jira corporate domain. Values: A valid URI.
email The email address associated with your Jira account.</description> email The email address associated with your Jira account.</description>

View File

@ -56,7 +56,7 @@ Quick Start Download the stand-alone, compiled binary. Unzip the downloaded fil
<guid>http://wtfutil.com/posts/installation/</guid> <guid>http://wtfutil.com/posts/installation/</guid>
<description>There are two ways to install WTF: <description>There are two ways to install WTF:
From Source Get this repo and install the dependencies: From Source Get this repo and install the dependencies:
go get github.com/senorprogrammer/wtf cd $GOPATH/github.com/senorprogrammer/wtf go get ./... make install make run and that should probably do it. go get github.com/senorprogrammer/wtf cd $GOPATH/src/github.com/senorprogrammer/wtf make install make run and that should probably do it.
As a Binary Grab the latest version from here: As a Binary Grab the latest version from here:
https://github.com/senorprogrammer/wtf/releases expand it, and cd into the resulting directory. Then run: https://github.com/senorprogrammer/wtf/releases expand it, and cd into the resulting directory. Then run:
./wtf and that should also do it.</description> ./wtf and that should also do it.</description>
@ -108,7 +108,7 @@ Key: j Action: Select the next item in the list.</description>
<description>Displays all Jira issues assigned to you for the specified project. <description>Displays all Jira issues assigned to you for the specified project.
Source Code wtf/jira/ Required ENV Variables Key: WTF_JIRA_API_KEY Value: Your Jira API key. Source Code wtf/jira/ Required ENV Variables Key: WTF_JIRA_API_KEY Value: Your Jira API key.
Keyboard Commands None. Keyboard Commands None.
Configuration jira:colors:rows:even:&amp;#34;lightblue&amp;#34;odd:&amp;#34;white&amp;#34;domain:&amp;#34;https://umbrellacorp.atlassian.net&amp;#34;email:&amp;#34;chriscummer@me.com&amp;#34;enabled:trueposition:top:4left:1height:1width:2project:&amp;#34;CORE&amp;#34;refreshInterval:900username:&amp;#34;chris.cummer&amp;#34; Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name. Configuration jira:colors:rows:even:&amp;#34;lightblue&amp;#34;odd:&amp;#34;white&amp;#34;domain:&amp;#34;https://umbrellacorp.atlassian.net&amp;#34;email:&amp;#34;chriscummer@me.com&amp;#34;enabled:trueposition:top:4left:1height:1width:2project:&amp;#34;JIRA&amp;#34;refreshInterval:900username:&amp;#34;chris.cummer&amp;#34; Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name.
colors.rows.odd Define the foreground color for odd-numbered rows. Values: Any X11 color name. colors.rows.odd Define the foreground color for odd-numbered rows. Values: Any X11 color name.
domain Your Jira corporate domain. Values: A valid URI. domain Your Jira corporate domain. Values: A valid URI.
email The email address associated with your Jira account.</description> email The email address associated with your Jira account.</description>

View File

@ -115,8 +115,7 @@
<p>Get this repo and install the dependencies:</p> <p>Get this repo and install the dependencies:</p>
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">go get github.com/senorprogrammer/wtf <div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">go get github.com/senorprogrammer/wtf
<span class="nb">cd</span> <span class="nv">$GOPATH</span>/github.com/senorprogrammer/wtf <span class="nb">cd</span> <span class="nv">$GOPATH</span>/src/github.com/senorprogrammer/wtf
go get ./...
make install make install
make run</code></pre></div> make run</code></pre></div>
<p>and that should probably do it.</p> <p>and that should probably do it.</p>

View File

@ -162,7 +162,7 @@ commit, and their status.</p>
</span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">8</span><span class="w"> </span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">8</span><span class="w">
</span><span class="w"> </span>repositories<span class="p">:</span><span class="w"> </span><span class="w"> </span>repositories<span class="p">:</span><span class="w">
</span><span class="w"> </span>-<span class="w"> </span><span class="s2">&#34;/Users/chris/go/src/github.com/senorprogrammer/wtf&#34;</span><span class="w"> </span><span class="w"> </span>-<span class="w"> </span><span class="s2">&#34;/Users/chris/go/src/github.com/senorprogrammer/wtf&#34;</span><span class="w">
</span><span class="w"> </span>-<span class="w"> </span><span class="s2">&#34;/Users/chris/Documents/Lendesk/fakeapp&#34;</span></code></pre></div> </span><span class="w"> </span>-<span class="w"> </span><span class="s2">&#34;/Users/user/fakeapp&#34;</span></code></pre></div>
<h3 id="attributes">Attributes</h3> <h3 id="attributes">Attributes</h3>
<p><code>commitCount</code> <br /> <p><code>commitCount</code> <br />

View File

@ -138,7 +138,7 @@
</span><span class="w"> </span>left<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="w"> </span>left<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
</span><span class="w"> </span>height<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="w"> </span>height<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
</span><span class="w"> </span>width<span class="p">:</span><span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="w"> </span>width<span class="p">:</span><span class="w"> </span><span class="m">2</span><span class="w">
</span><span class="w"> </span>project<span class="p">:</span><span class="w"> </span><span class="s2">&#34;CORE&#34;</span><span class="w"> </span><span class="w"> </span>project<span class="p">:</span><span class="w"> </span><span class="s2">&#34;JIRA&#34;</span><span class="w">
</span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">900</span><span class="w"> </span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">900</span><span class="w">
</span><span class="w"> </span>username<span class="p">:</span><span class="w"> </span><span class="s2">&#34;chris.cummer&#34;</span></code></pre></div> </span><span class="w"> </span>username<span class="p">:</span><span class="w"> </span><span class="s2">&#34;chris.cummer&#34;</span></code></pre></div>
<h3 id="attributes">Attributes</h3> <h3 id="attributes">Attributes</h3>