taigrr/wtf
1
0
Fork 0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00
Code Issues Projects Releases Wiki Activity

Update new config paths in documentation

Browse Source
This commit is contained in:
Chris Cummer 2018-06-20 16:59:11 -07:00
parent 0e141e03c8
commit 343612eb5e
11 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
_sample_configs/complex_config.yml
View File

@ -77,11 +77,11 @@ wtf:
height: 4
width: 1
refreshInterval: 300
secretFile: "~/.wtf/gcal/client_secret.json"
secretFile: "~/.config/wtf/gcal/client_secret.json"
withLocation: true
gspreadsheets:
enabled: true
secretFile: "~/.wtf/gspreadsheets/client_secret.json"
secretFile: "~/.config/wtf/gspreadsheets/client_secret.json"
refreshInterval: "300"
sheetId: "id_of_google_spreadsheet"
colors:
@ -223,7 +223,7 @@ wtf:
displayHoldings: true
refreshInterval: 400
device_token: "device token here, you can find how to get it here https://github.com/bob6664569/blockfolio-api-client"
colors:
colors:
name: blue
grows: green
drop: red
@ -231,4 +231,4 @@ wtf:
top: 3
left: 1
width: 1
height: 1
height: 1

2
_sample_configs/simple_config.yml
View File

@ -56,7 +56,7 @@ wtf:
refreshInterval: 3600
textfile:
enabled: true
filePath: "~/.wtf/config.yml"
filePath: "~/.config/wtf/config.yml"
position:
top: 1
left: 1

10
_site/content/posts/configuration.md
View File

@ -12,12 +12,12 @@ draft: false
## Configuration Files
By default WTF looks in a `~/.wtf/` directory for a YAML file called
`config.yml`. If the `~/.wtf/` directory doesn't exist, WTF will create that directory
By default WTF looks in a `~/.config/wtf/` directory for a YAML file called
`config.yml`. If the `~/.config/wtf/` directory doesn't exist, WTF will create that directory
on start-up, and then display instructions for creating a new
configuration file.
In other words, WTF expects to have a YAML config file at: `~/.wtf/config.yml`.
In other words, WTF expects to have a YAML config file at: `~/.config/wtf/config.yml`.
#### Example Configuration Files
@ -25,7 +25,7 @@ A couple of example config files are provided in the `_sample_configs/`
directory of the Git repository.
To try out WTF quickly, copy
`simple_config.yml` into `~/.wtf/` as `config.yml` and relaunch WTF. You
`simple_config.yml` into `~/.config/wtf/` as `config.yml` and relaunch WTF. You
should see the app launch and display the <a href="/posts/modules/security/">Security</a>,
<a href="/posts/modules/clocks/">Clocks</a> and <a href="/posts/modules/status/">Status</a> widgets onscreen.
@ -36,7 +36,7 @@ you can pass the path to a config file via command line arguments on
start-up.
To load a custom configuration file (ie: one that's not
`~/.wtf/config.yml`), pass in the path to configuration file as a
`~/.config/wtf/config.yml`), pass in the path to configuration file as a
parameter on launch:
```bash

2
_site/content/posts/modules/gcal.md
View File

@ -51,7 +51,7 @@ gcal:
height: 4
width: 1
refreshInterval: 300
secretFile: "~/.wtf/gcal/client_secret.json"
secretFile: "~/.config/wtf/gcal/client_secret.json"
withLocation: true
```

2
_site/content/posts/modules/gspreadsheet.md
View File

@ -40,7 +40,7 @@ gspreadsheets:
width: 1
height: 1
refreshInterval: "300"
secretFile: "~/.wtf/gspreadsheets/client_secret.json"
secretFile: "~/.config/wtf/gspreadsheets/client_secret.json"
sheetId: "id_of_google_spreadsheet"
```

2
cfg/config_files.go
View File

@ -205,7 +205,7 @@ const simpleConfig = `wtf:
refreshInterval: 3600
textfile:
enabled: true
filePath: "~/.wtf/config.yml"
filePath: "~/.config/wtf/config.yml"
position:
top: 1
left: 1

8
docs/index.xml
View File

@ -81,7 +81,7 @@ position Defines where in the grid this module&amp;rsquo;s widget will be displa
Display information from cells in a Google Spreadsheet.
wtf/gspreadsheets/ Required ENV Variables None.
Keyboard Commands None.
Configuration gspreadsheets:colors:values:&amp;#34;green&amp;#34;cells:names:-&amp;#34;Cell 1 name&amp;#34;-&amp;#34;Cell 2 name&amp;#34;addresses:-&amp;#34;A1&amp;#34;-&amp;#34;A2&amp;#34;enabled:trueposition:top:0left:0width:1height:1refreshInterval:&amp;#34;300&amp;#34;secretFile:&amp;#34;~/.wtf/gspreadsheets/client_secret.json&amp;#34;sheetId:&amp;#34;id_of_google_spreadsheet&amp;#34; Attributes colors.values The color to display the cell values in. Values: Any X11 color name.
Configuration gspreadsheets:colors:values:&amp;#34;green&amp;#34;cells:names:-&amp;#34;Cell 1 name&amp;#34;-&amp;#34;Cell 2 name&amp;#34;addresses:-&amp;#34;A1&amp;#34;-&amp;#34;A2&amp;#34;enabled:trueposition:top:0left:0width:1height:1refreshInterval:&amp;#34;300&amp;#34;secretFile:&amp;#34;~/.config/wtf/gspreadsheets/client_secret.json&amp;#34;sheetId:&amp;#34;id_of_google_spreadsheet&amp;#34; Attributes colors.values The color to display the cell values in. Values: Any X11 color name.
cells.names cells.addresses enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.
position Where in the grid this module&amp;rsquo;s widget will be displayed.</description>
</item>
@ -306,7 +306,7 @@ trello:board:Mainenabled:truelist:[&amp;#34;Todo&amp;#34;,&amp;#34;Done&amp;#34;
Not: Setting up access to Google Calendars for Go is a bit unobvious. Check out Google&amp;rsquo;s Go Quickstart first and if you have problems, then take a look at this comment by WesleydeSouza which offers a slightly different approach.
Source Code wtf/gcal/ Required ENV Variables None.
Keyboard Commands None.
Configuration gcal:colors:title:&amp;#34;red&amp;#34;description:&amp;#34;lightblue&amp;#34;highlights:-[&amp;#39;1on1|1\/11&amp;#39;,&amp;#39;green&amp;#39;]-[&amp;#39;apple|google|aws&amp;#39;,&amp;#39;blue&amp;#39;]-[&amp;#39;interview|meet&amp;#39;,&amp;#39;magenta&amp;#39;]-[&amp;#39;lunch&amp;#39;,&amp;#39;yellow&amp;#39;]past:&amp;#34;gray&amp;#34;conflictIcon:&amp;#34;🚨&amp;#34;currentIcon:&amp;#34;💥&amp;#34;displayResponseStatus:trueemail:&amp;#34;chriscummer@me.com&amp;#34;enabled:trueeventCount:12multiCalendar:trueposition:top:0left:0height:4width:1refreshInterval:300secretFile:&amp;#34;~/.wtf/gcal/client_secret.json&amp;#34;withLocation:true Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name.</description>
Configuration gcal:colors:title:&amp;#34;red&amp;#34;description:&amp;#34;lightblue&amp;#34;highlights:-[&amp;#39;1on1|1\/11&amp;#39;,&amp;#39;green&amp;#39;]-[&amp;#39;apple|google|aws&amp;#39;,&amp;#39;blue&amp;#39;]-[&amp;#39;interview|meet&amp;#39;,&amp;#39;magenta&amp;#39;]-[&amp;#39;lunch&amp;#39;,&amp;#39;yellow&amp;#39;]past:&amp;#34;gray&amp;#34;conflictIcon:&amp;#34;🚨&amp;#34;currentIcon:&amp;#34;💥&amp;#34;displayResponseStatus:trueemail:&amp;#34;chriscummer@me.com&amp;#34;enabled:trueeventCount:12multiCalendar:trueposition:top:0left:0height:4width:1refreshInterval:300secretFile:&amp;#34;~/.config/wtf/gcal/client_secret.json&amp;#34;withLocation:true Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name.</description>
</item>
<item>
@ -462,8 +462,8 @@ Widgets are defined by a required widget.go file in a Module.</description>
<pubDate>Sun, 15 Apr 2018 21:17:16 -0700</pubDate>
<guid>https://wtfutil.com/posts/configuration/</guid>
<description>Index Configuration Files Environment (ENV) Variables Grid Layout Configuration Files By default WTF looks in a ~/.wtf/ directory for a YAML file called config.yml. If the ~/.wtf/ directory doesn&amp;rsquo;t exist, WTF will create that directory on start-up, and then display instructions for creating a new configuration file.
In other words, WTF expects to have a YAML config file at: ~/.wtf/config.yml.
<description>Index Configuration Files Environment (ENV) Variables Grid Layout Configuration Files By default WTF looks in a ~/.config/wtf/ directory for a YAML file called config.yml. If the ~/.config/wtf/ directory doesn&amp;rsquo;t exist, WTF will create that directory on start-up, and then display instructions for creating a new configuration file.
In other words, WTF expects to have a YAML config file at: ~/.config/wtf/config.yml.
Example Configuration Files A couple of example config files are provided in the _sample_configs/ directory of the Git repository.</description>
</item>

10
docs/posts/configuration/index.html
View File

@ -131,12 +131,12 @@
<h2 id="configuration-files">Configuration Files</h2>
<p>By default WTF looks in a <code>~/.wtf/</code> directory for a YAML file called
<code>config.yml</code>. If the <code>~/.wtf/</code> directory doesn&rsquo;t exist, WTF will create that directory
<p>By default WTF looks in a <code>~/.config/wtf/</code> directory for a YAML file called
<code>config.yml</code>. If the <code>~/.config/wtf/</code> directory doesn&rsquo;t exist, WTF will create that directory
on start-up, and then display instructions for creating a new
configuration file.</p>
<p>In other words, WTF expects to have a YAML config file at: <code>~/.wtf/config.yml</code>.</p>
<p>In other words, WTF expects to have a YAML config file at: <code>~/.config/wtf/config.yml</code>.</p>
<h4 id="example-configuration-files">Example Configuration Files</h4>
@ -144,7 +144,7 @@ configuration file.</p>
directory of the Git repository.</p>
<p>To try out WTF quickly, copy
<code>simple_config.yml</code> into <code>~/.wtf/</code> as <code>config.yml</code> and relaunch WTF. You
<code>simple_config.yml</code> into <code>~/.config/wtf/</code> as <code>config.yml</code> and relaunch WTF. You
should see the app launch and display the <a href="/posts/modules/security/">Security</a>,
<a href="/posts/modules/clocks/">Clocks</a> and <a href="/posts/modules/status/">Status</a> widgets onscreen.</p>
@ -155,7 +155,7 @@ you can pass the path to a config file via command line arguments on
start-up.</p>
<p>To load a custom configuration file (ie: one that&rsquo;s not
<code>~/.wtf/config.yml</code>), pass in the path to configuration file as a
<code>~/.config/wtf/config.yml</code>), pass in the path to configuration file as a
parameter on launch:</p>
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash"> $&gt; wtf --config<span class="o">=</span>path/to/custom/config.yml</code></pre></div>
<h4 id="configuration-attributes">Configuration Attributes</h4>

8
docs/posts/index.xml
View File

@ -81,7 +81,7 @@ position Defines where in the grid this module&amp;rsquo;s widget will be displa
Display information from cells in a Google Spreadsheet.
wtf/gspreadsheets/ Required ENV Variables None.
Keyboard Commands None.
Configuration gspreadsheets:colors:values:&amp;#34;green&amp;#34;cells:names:-&amp;#34;Cell 1 name&amp;#34;-&amp;#34;Cell 2 name&amp;#34;addresses:-&amp;#34;A1&amp;#34;-&amp;#34;A2&amp;#34;enabled:trueposition:top:0left:0width:1height:1refreshInterval:&amp;#34;300&amp;#34;secretFile:&amp;#34;~/.wtf/gspreadsheets/client_secret.json&amp;#34;sheetId:&amp;#34;id_of_google_spreadsheet&amp;#34; Attributes colors.values The color to display the cell values in. Values: Any X11 color name.
Configuration gspreadsheets:colors:values:&amp;#34;green&amp;#34;cells:names:-&amp;#34;Cell 1 name&amp;#34;-&amp;#34;Cell 2 name&amp;#34;addresses:-&amp;#34;A1&amp;#34;-&amp;#34;A2&amp;#34;enabled:trueposition:top:0left:0width:1height:1refreshInterval:&amp;#34;300&amp;#34;secretFile:&amp;#34;~/.config/wtf/gspreadsheets/client_secret.json&amp;#34;sheetId:&amp;#34;id_of_google_spreadsheet&amp;#34; Attributes colors.values The color to display the cell values in. Values: Any X11 color name.
cells.names cells.addresses enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.
position Where in the grid this module&amp;rsquo;s widget will be displayed.</description>
</item>
@ -306,7 +306,7 @@ trello:board:Mainenabled:truelist:[&amp;#34;Todo&amp;#34;,&amp;#34;Done&amp;#34;
Not: Setting up access to Google Calendars for Go is a bit unobvious. Check out Google&amp;rsquo;s Go Quickstart first and if you have problems, then take a look at this comment by WesleydeSouza which offers a slightly different approach.
Source Code wtf/gcal/ Required ENV Variables None.
Keyboard Commands None.
Configuration gcal:colors:title:&amp;#34;red&amp;#34;description:&amp;#34;lightblue&amp;#34;highlights:-[&amp;#39;1on1|1\/11&amp;#39;,&amp;#39;green&amp;#39;]-[&amp;#39;apple|google|aws&amp;#39;,&amp;#39;blue&amp;#39;]-[&amp;#39;interview|meet&amp;#39;,&amp;#39;magenta&amp;#39;]-[&amp;#39;lunch&amp;#39;,&amp;#39;yellow&amp;#39;]past:&amp;#34;gray&amp;#34;conflictIcon:&amp;#34;🚨&amp;#34;currentIcon:&amp;#34;💥&amp;#34;displayResponseStatus:trueemail:&amp;#34;chriscummer@me.com&amp;#34;enabled:trueeventCount:12multiCalendar:trueposition:top:0left:0height:4width:1refreshInterval:300secretFile:&amp;#34;~/.wtf/gcal/client_secret.json&amp;#34;withLocation:true Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name.</description>
Configuration gcal:colors:title:&amp;#34;red&amp;#34;description:&amp;#34;lightblue&amp;#34;highlights:-[&amp;#39;1on1|1\/11&amp;#39;,&amp;#39;green&amp;#39;]-[&amp;#39;apple|google|aws&amp;#39;,&amp;#39;blue&amp;#39;]-[&amp;#39;interview|meet&amp;#39;,&amp;#39;magenta&amp;#39;]-[&amp;#39;lunch&amp;#39;,&amp;#39;yellow&amp;#39;]past:&amp;#34;gray&amp;#34;conflictIcon:&amp;#34;🚨&amp;#34;currentIcon:&amp;#34;💥&amp;#34;displayResponseStatus:trueemail:&amp;#34;chriscummer@me.com&amp;#34;enabled:trueeventCount:12multiCalendar:trueposition:top:0left:0height:4width:1refreshInterval:300secretFile:&amp;#34;~/.config/wtf/gcal/client_secret.json&amp;#34;withLocation:true Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name.</description>
</item>
<item>
@ -462,8 +462,8 @@ Widgets are defined by a required widget.go file in a Module.</description>
<pubDate>Sun, 15 Apr 2018 21:17:16 -0700</pubDate>
<guid>https://wtfutil.com/posts/configuration/</guid>
<description>Index Configuration Files Environment (ENV) Variables Grid Layout Configuration Files By default WTF looks in a ~/.wtf/ directory for a YAML file called config.yml. If the ~/.wtf/ directory doesn&amp;rsquo;t exist, WTF will create that directory on start-up, and then display instructions for creating a new configuration file.
In other words, WTF expects to have a YAML config file at: ~/.wtf/config.yml.
<description>Index Configuration Files Environment (ENV) Variables Grid Layout Configuration Files By default WTF looks in a ~/.config/wtf/ directory for a YAML file called config.yml. If the ~/.config/wtf/ directory doesn&amp;rsquo;t exist, WTF will create that directory on start-up, and then display instructions for creating a new configuration file.
In other words, WTF expects to have a YAML config file at: ~/.config/wtf/config.yml.
Example Configuration Files A couple of example config files are provided in the _sample_configs/ directory of the Git repository.</description>
</item>

2
docs/posts/modules/gcal/index.html
View File

@ -162,7 +162,7 @@ first and if you have problems, then take a look at this <a href="https://github
</span><span class="w"> </span>height<span class="p">:</span><span class="w"> </span><span class="m">4</span><span class="w">
</span><span class="w"> </span>width<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
</span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">300</span><span class="w">
</span><span class="w"> </span>secretFile<span class="p">:</span><span class="w"> </span><span class="s2">&#34;~/.wtf/gcal/client_secret.json&#34;</span><span class="w">
</span><span class="w"> </span>secretFile<span class="p">:</span><span class="w"> </span><span class="s2">&#34;~/.config/wtf/gcal/client_secret.json&#34;</span><span class="w">
</span><span class="w"> </span>withLocation<span class="p">:</span><span class="w"> </span><span class="kc">true</span></code></pre></div>
<h3 id="attributes">Attributes</h3>

2
docs/posts/modules/gspreadsheet/index.html
View File

@ -151,7 +151,7 @@
</span><span class="w"> </span>width<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>refreshInterval<span class="p">:</span><span class="w"> </span><span class="s2">&#34;300&#34;</span><span class="w">
</span><span class="w"> </span>secretFile<span class="p">:</span><span class="w"> </span><span class="s2">&#34;~/.wtf/gspreadsheets/client_secret.json&#34;</span><span class="w">
</span><span class="w"> </span>secretFile<span class="p">:</span><span class="w"> </span><span class="s2">&#34;~/.config/wtf/gspreadsheets/client_secret.json&#34;</span><span class="w">
</span><span class="w"> </span>sheetId<span class="p">:</span><span class="w"> </span><span class="s2">&#34;id_of_google_spreadsheet&#34;</span></code></pre></div>
<h3 id="attributes">Attributes</h3>