diff --git a/_sample_configs/complex_config.yml b/_sample_configs/complex_config.yml index 57e3f41c..0e95932c 100644 --- a/_sample_configs/complex_config.yml +++ b/_sample_configs/complex_config.yml @@ -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 \ No newline at end of file + height: 1 diff --git a/_sample_configs/simple_config.yml b/_sample_configs/simple_config.yml index efa5d2bf..34e9de9f 100644 --- a/_sample_configs/simple_config.yml +++ b/_sample_configs/simple_config.yml @@ -56,7 +56,7 @@ wtf: refreshInterval: 3600 textfile: enabled: true - filePath: "~/.wtf/config.yml" + filePath: "~/.config/wtf/config.yml" position: top: 1 left: 1 diff --git a/_site/content/posts/configuration.md b/_site/content/posts/configuration.md index af97ed86..9337d213 100644 --- a/_site/content/posts/configuration.md +++ b/_site/content/posts/configuration.md @@ -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 Security, Clocks and Status 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 diff --git a/_site/content/posts/modules/gcal.md b/_site/content/posts/modules/gcal.md index a0bcd9ec..5dbfa014 100644 --- a/_site/content/posts/modules/gcal.md +++ b/_site/content/posts/modules/gcal.md @@ -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 ``` diff --git a/_site/content/posts/modules/gspreadsheet.md b/_site/content/posts/modules/gspreadsheet.md index 0d3e5a94..aaea2384 100644 --- a/_site/content/posts/modules/gspreadsheet.md +++ b/_site/content/posts/modules/gspreadsheet.md @@ -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" ``` diff --git a/cfg/config_files.go b/cfg/config_files.go index 7f6dfc0a..5d41bfcd 100644 --- a/cfg/config_files.go +++ b/cfg/config_files.go @@ -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 diff --git a/docs/index.xml b/docs/index.xml index 0fe27cfa..5cc6df8c 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -81,7 +81,7 @@ position Defines where in the grid this module’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:"green"cells:names:-"Cell 1 name"-"Cell 2 name"addresses:-"A1"-"A2"enabled:trueposition:top:0left:0width:1height:1refreshInterval:"300"secretFile:"~/.wtf/gspreadsheets/client_secret.json"sheetId:"id_of_google_spreadsheet" Attributes colors.values The color to display the cell values in. Values: Any X11 color name. +Configuration gspreadsheets:colors:values:"green"cells:names:-"Cell 1 name"-"Cell 2 name"addresses:-"A1"-"A2"enabled:trueposition:top:0left:0width:1height:1refreshInterval:"300"secretFile:"~/.config/wtf/gspreadsheets/client_secret.json"sheetId:"id_of_google_spreadsheet" 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’s widget will be displayed. @@ -306,7 +306,7 @@ trello:board:Mainenabled:truelist:["Todo","Done" Not: Setting up access to Google Calendars for Go is a bit unobvious. Check out Google’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:"red"description:"lightblue"highlights:-['1on1|1\/11','green']-['apple|google|aws','blue']-['interview|meet','magenta']-['lunch','yellow']past:"gray"conflictIcon:"🚨"currentIcon:"💥"displayResponseStatus:trueemail:"chriscummer@me.com"enabled:trueeventCount:12multiCalendar:trueposition:top:0left:0height:4width:1refreshInterval:300secretFile:"~/.wtf/gcal/client_secret.json"withLocation:true Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name. +Configuration gcal:colors:title:"red"description:"lightblue"highlights:-['1on1|1\/11','green']-['apple|google|aws','blue']-['interview|meet','magenta']-['lunch','yellow']past:"gray"conflictIcon:"🚨"currentIcon:"💥"displayResponseStatus:trueemail:"chriscummer@me.com"enabled:trueeventCount:12multiCalendar:trueposition:top:0left:0height:4width:1refreshInterval:300secretFile:"~/.config/wtf/gcal/client_secret.json"withLocation:true Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name. @@ -462,8 +462,8 @@ Widgets are defined by a required widget.go file in a Module. Sun, 15 Apr 2018 21:17:16 -0700 https://wtfutil.com/posts/configuration/ - 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’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. + 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’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. diff --git a/docs/posts/configuration/index.html b/docs/posts/configuration/index.html index 048b2898..436ed0af 100644 --- a/docs/posts/configuration/index.html +++ b/docs/posts/configuration/index.html @@ -131,12 +131,12 @@

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

@@ -144,7 +144,7 @@ configuration file.

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 Security, Clocks and Status widgets onscreen.

@@ -155,7 +155,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:

    $> wtf --config=path/to/custom/config.yml

Configuration Attributes

diff --git a/docs/posts/index.xml b/docs/posts/index.xml index 4b774386..490c9f72 100644 --- a/docs/posts/index.xml +++ b/docs/posts/index.xml @@ -81,7 +81,7 @@ position Defines where in the grid this module’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:"green"cells:names:-"Cell 1 name"-"Cell 2 name"addresses:-"A1"-"A2"enabled:trueposition:top:0left:0width:1height:1refreshInterval:"300"secretFile:"~/.wtf/gspreadsheets/client_secret.json"sheetId:"id_of_google_spreadsheet" Attributes colors.values The color to display the cell values in. Values: Any X11 color name. +Configuration gspreadsheets:colors:values:"green"cells:names:-"Cell 1 name"-"Cell 2 name"addresses:-"A1"-"A2"enabled:trueposition:top:0left:0width:1height:1refreshInterval:"300"secretFile:"~/.config/wtf/gspreadsheets/client_secret.json"sheetId:"id_of_google_spreadsheet" 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’s widget will be displayed. @@ -306,7 +306,7 @@ trello:board:Mainenabled:truelist:["Todo","Done" Not: Setting up access to Google Calendars for Go is a bit unobvious. Check out Google’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:"red"description:"lightblue"highlights:-['1on1|1\/11','green']-['apple|google|aws','blue']-['interview|meet','magenta']-['lunch','yellow']past:"gray"conflictIcon:"🚨"currentIcon:"💥"displayResponseStatus:trueemail:"chriscummer@me.com"enabled:trueeventCount:12multiCalendar:trueposition:top:0left:0height:4width:1refreshInterval:300secretFile:"~/.wtf/gcal/client_secret.json"withLocation:true Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name. +Configuration gcal:colors:title:"red"description:"lightblue"highlights:-['1on1|1\/11','green']-['apple|google|aws','blue']-['interview|meet','magenta']-['lunch','yellow']past:"gray"conflictIcon:"🚨"currentIcon:"💥"displayResponseStatus:trueemail:"chriscummer@me.com"enabled:trueeventCount:12multiCalendar:trueposition:top:0left:0height:4width:1refreshInterval:300secretFile:"~/.config/wtf/gcal/client_secret.json"withLocation:true Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name. @@ -462,8 +462,8 @@ Widgets are defined by a required widget.go file in a Module. Sun, 15 Apr 2018 21:17:16 -0700 https://wtfutil.com/posts/configuration/ - 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’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. + 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’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. diff --git a/docs/posts/modules/gcal/index.html b/docs/posts/modules/gcal/index.html index ed7fb6c0..c3835d60 100644 --- a/docs/posts/modules/gcal/index.html +++ b/docs/posts/modules/gcal/index.html @@ -162,7 +162,7 @@ first and if you have problems, then take a look at this height: 4 width: 1 refreshInterval: 300 - secretFile: "~/.wtf/gcal/client_secret.json" + secretFile: "~/.config/wtf/gcal/client_secret.json" withLocation: true

Attributes

diff --git a/docs/posts/modules/gspreadsheet/index.html b/docs/posts/modules/gspreadsheet/index.html index 49d1a994..a44dbeee 100644 --- a/docs/posts/modules/gspreadsheet/index.html +++ b/docs/posts/modules/gspreadsheet/index.html @@ -151,7 +151,7 @@ width: 1 height: 1 refreshInterval: "300" - secretFile: "~/.wtf/gspreadsheets/client_secret.json" + secretFile: "~/.config/wtf/gspreadsheets/client_secret.json" sheetId: "id_of_google_spreadsheet"

Attributes