starred/komorebi
1
0
Fork 0
mirror of https://github.com/LGUG2Z/komorebi.git synced 2026-03-26 19:31:16 +01:00
Code Issues 87 Packages Projects Releases 10 Wiki Activity

docs(readme): add section for example config

Browse Source
This commit is contained in:
LGUG2Z
2022-12-06 19:02:26 -08:00
parent 97423fc8e9
commit a2bd277620
1 changed files with 14 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -165,11 +165,6 @@ binaries from the latest GitHub Release:
```powershell
scoop bucket add extras
scoop install komorebi
# To download the example configuration
iwr https://raw.githubusercontent.com/LGUG2Z/komorebi/master/komorebi.sample.ahk -OutFile $Env:USERPROFILE\komorebi.ahk
iwr https://raw.githubusercontent.com/LGUG2Z/komorebi/master/komorebic.lib.ahk -OutFile $Env:USERPROFILE\komorebic.lib.ahk
iwr https://raw.githubusercontent.com/LGUG2Z/komorebi/master/komorebi.generated.ahk -OutFile $Env:USERPROFILE\komorebi.generated.ahk
```
If you install _komorebi_ using Scoop, the binaries will automatically be added to your `Path`.
@@ -190,6 +185,20 @@ cargo install --path komorebi --locked
cargo install --path komorebic --locked
```
### Using Example Configurations
To download example configurations from this repository, which will work regardless of your installation method, you may
run the following commands at a PowerShell prompt.
These commands will download the `komorebi.sample.ahk`, `komorebic.lib.ahk` and `komorebi.generated.ahk` files from the
master branch of this repository and save them to your `$HOME` directory.
```powershell
iwr https://raw.githubusercontent.com/LGUG2Z/komorebi/master/komorebi.sample.ahk -OutFile $Env:USERPROFILE\komorebi.ahk
iwr https://raw.githubusercontent.com/LGUG2Z/komorebi/master/komorebic.lib.ahk -OutFile $Env:USERPROFILE\komorebic.lib.ahk
iwr https://raw.githubusercontent.com/LGUG2Z/komorebi/master/komorebi.generated.ahk -OutFile $Env:USERPROFILE\komorebi.generated.ahk
```
### Running
Once you have either the prebuilt binaries in your `Path`, or have compiled the binaries from source (these will already