starred/komorebi
1
0
Fork 0
mirror of https://github.com/LGUG2Z/komorebi.git synced 2026-03-31 14:33:29 +02:00
Code Issues 87 Packages Projects Releases 10 Wiki Activity

docs(mkdocs): start building dedicated site

Browse Source
This commit is contained in:
LGUG2Z
2024-01-12 18:40:58 -08:00
parent 57a3ba6d57
commit 6f08ec1cb3
7 changed files with 188 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/install/build-from-source.md Normal file
View File

@@ -0,0 +1,19 @@
## Installing From Source
First, [install `rustup`](https://rustup.rs/) to get the `rust` compiler installed on your system, and make sure you have installed the [Visual Studio prerequisites](https://rust-lang.github.io/rustup/installation/windows-msvc.html).
Then clone the git repository.
```powershell
git clone https://github.com/LGUG2Z/komorebi.git
```
Once inside the repository, you will need to build and install three separate binaries.
```powershell
cargo +stable install --path komorebi --locked
cargo +stable install --path komorebic --locked
cargo +stable install --path komorebic-no-console --locked
```
If the binaries have been built and added to your `$PATH` correctly, you should see some output when running `komorebi --help` and `komorebic --help`

20
docs/install/scoop.md Normal file
View File

@@ -0,0 +1,20 @@
## Installing with Scoop
It highly recommended that you enable support for long paths in Windows by running the following command in an Administrator Terminal before installing komorebi.
```powershell
Set-ItemProperty 'HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem' -Name 'LongPathsEnabled' -Value 1
```
### Add the Extras bucket
```
scoop bucket add extras
```
### Install komorebi and whkd
This command installs `komorebi` and `whkd`.
```
scoop install komorebi whkd
```
Once komorebi is installed, proceed to get the [example configurations](../getting-started.html#getting-example-configurations).

16
docs/install/winget.md Normal file
View File

@@ -0,0 +1,16 @@
## Installing with Scoop
It highly recommended that you enable support for long paths in Windows by running the following command in an Administrator Terminal before installing komorebi.
```powershell
Set-ItemProperty 'HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem' -Name 'LongPathsEnabled' -Value 1
```
### Install komorebi and whkd
This command installs `komorebi` and `whkd`.
```
winget install LGUG2Z.komorebi
winget install LGUG2Z.whkd
```
Once komorebi is installed, proceed to get the [example configurations](../getting-started.html#getting-example-configurations).