From a2bd277620c944b6a9516ec8c5a2c3c3cce7969b Mon Sep 17 00:00:00 2001 From: LGUG2Z Date: Tue, 6 Dec 2022 19:02:26 -0800 Subject: [PATCH] docs(readme): add section for example config --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4389c75a..3be38566 100644 --- a/README.md +++ b/README.md @@ -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