vtimofei
/
surfingkeys-conf
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improve README installation instructions

This commit is contained in:
Maddison Hellstrom 2018-08-18 16:32:36 -07:00
parent 38e5e39523
commit 6222f081f9
2 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -125,10 +125,13 @@ If you already have a file in that location, make sure you back it up first!
- __II.__ Open the SurfingKeys [configuration page](chrome-extension://mffcegbjcdejldmihkogmcnkgbbhioid/pages/options.html)
- __III.__ Set the `Load settings from` option to point to the configuration file _(Note: you must specify the full, absolute path; environment variables like '$HOME' or the tilde `~` won't work)_:
- __Linux__: `file:///home/$USER/.surfingkeys`
- __macOS__: `file:///Users/$USER/.surfingkeys`
- __Windows__: `file://%Homedrive%%Homepath%/.surfingkeys` (This is a guess, please correct me if I'm wrong.)
- __III.__ Set the `Load settings from` option to point to the configuration file.
_Note: you must specify the full, absolute path; environment variables like `$HOME` or the tilde `~` won't work_:
- __Linux__: `file:///home/{USERNAME}/.surfingkeys` (replace `{USERNAME}` with your username)
- __macOS__: `file:///Users/{USERNAME}/.surfingkeys` (replace `{USERNAME}` with your username)
- __Windows__: `file://%Homedrive%%Homepath%/.surfingkeys` (This is a guess, please correct me if I'm wrong)
- __IV.__ Hack Away! If you ever make a change to any of your configuration files in the future, simply run `gulp install` again and your new configuration will automatically be loaded by SurfingKeys.

11
README.tmpl.md
View File

@ -76,10 +76,13 @@ If you already have a file in that location, make sure you back it up first!
- __II.__ Open the SurfingKeys [configuration page](chrome-extension://mffcegbjcdejldmihkogmcnkgbbhioid/pages/options.html)
- __III.__ Set the `Load settings from` option to point to the configuration file _(Note: you must specify the full, absolute path; environment variables like '$HOME' or the tilde `~` won't work)_:
- __Linux__: `file:///home/$USER/.surfingkeys`
- __macOS__: `file:///Users/$USER/.surfingkeys`
- __Windows__: `file://%Homedrive%%Homepath%/.surfingkeys` (This is a guess, please correct me if I'm wrong.)
- __III.__ Set the `Load settings from` option to point to the configuration file.
_Note: you must specify the full, absolute path; environment variables like `$HOME` or the tilde `~` won't work_:
- __Linux__: `file:///home/{USERNAME}/.surfingkeys` (replace `{USERNAME}` with your username)
- __macOS__: `file:///Users/{USERNAME}/.surfingkeys` (replace `{USERNAME}` with your username)
- __Windows__: `file://%Homedrive%%Homepath%/.surfingkeys` (This is a guess, please correct me if I'm wrong)
- __IV.__ Hack Away! If you ever make a change to any of your configuration files in the future, simply run `gulp install` again and your new configuration will automatically be loaded by SurfingKeys.