mirror of
https://github.com/LGUG2Z/komorebi.git
synced 2026-11-16 05:41:16 +01:00
docs(mkdocs): add homebrew installation instructions
This commit is contained in:
1 parent
2ecc2819ec
commit
202238aecd
4 files changed
+81
-6
No files matched your search
@@ -19,8 +19,9 @@ komorebic quickstart
|
||||
|
||||
### Granting Permissions
|
||||
|
||||
The `quickstart` command will also prompt you to grant komorebi the permissions
|
||||
it requires to run, and will open the following System Settings tabs for you:
|
||||
The `quickstart` command will also prompt you to grant komorebi and the terminal
|
||||
emulator you are start komorebi with the permissions it requires to run, and
|
||||
will open the following System Settings tabs for you:
|
||||
|
||||
* Settings -> Privacy & Security -> Accessibility
|
||||
* Settings -> Privacy & Security -> Screen & System Audio Recording
|
||||
|
||||
+73
-1
@@ -16,7 +16,12 @@ using keyboard shortcuts.
|
||||
|
||||
## Installation
|
||||
|
||||
At this time users must compile `komorebi` from source.
|
||||
Nightly builds are available to install
|
||||
via [Homebrew](https://github.com/LGUG2Z/homebrew-tap), and you may also build
|
||||
from source if you would prefer.
|
||||
|
||||
- [Homebrew](#homebrew)
|
||||
- [Building from source](#building-from-source)
|
||||
|
||||
## System settings suggestions
|
||||
|
||||
@@ -32,6 +37,73 @@ monitor which it was launched on.
|
||||
Go to `System Settings -> Desktop & Dock -> Mission Control -> Group windows
|
||||
by application` and disable this option if you like to use mission control.
|
||||
|
||||
## Homebrew
|
||||
|
||||
First add the `lgug2z/tap` Homebrew Tap
|
||||
|
||||
```shell
|
||||
brew tap lgug2z/tap
|
||||
```
|
||||
|
||||
Then install the `komorebi-for-mac-nightly` package
|
||||
|
||||
```shell
|
||||
brew install lgug2z/tap/komorebi-for-mac-nightly
|
||||
```
|
||||
|
||||
You may also optionally install the `skhd` package
|
||||
|
||||
```shell
|
||||
brew install skhd
|
||||
```
|
||||
|
||||
## Nix Flake
|
||||
|
||||
Ensure that your system Flake is configured to use your GitHub token so that you can add a private repository as an input
|
||||
|
||||
```nix
|
||||
{
|
||||
nix = {
|
||||
settings = {
|
||||
access-tokens = [
|
||||
"github.com=YOUR ACCESS TOKEN"
|
||||
];
|
||||
};
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
Add the repository as an input
|
||||
|
||||
```nix
|
||||
{
|
||||
inputs.komorebi-for-mac.url = "github:KomoCorp/komorebi-for-mac";
|
||||
}
|
||||
```
|
||||
|
||||
Add the overlay to your system's nixpkgs configuration
|
||||
|
||||
```nix
|
||||
{
|
||||
pkgs = import nixpkgs {
|
||||
inherit system;
|
||||
overlays = [ komorebi-for-mac.overlays.default ];
|
||||
# the rest of your pkgs configuration
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
Add `pkgs.komorebi-full` to `environment.systemPackages` (you may also add
|
||||
`pkgs.komorebi`, `pkgs.komorebic` and `pkgs.komorebi-bar` individually)
|
||||
|
||||
```nix
|
||||
{
|
||||
environment.systemPackages = [
|
||||
pkgs.komorebi-full
|
||||
];
|
||||
}
|
||||
```
|
||||
|
||||
## Building from source
|
||||
|
||||
Make sure you have installed [`rustup`](https://rustup.rs), and a stable `rust`
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"$schema": "https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.38/schema.json",
|
||||
"$schema": "https://gist.githubusercontent.com/LGUG2Z/78b3dd12a7b7069f1d1c60621fe50730/raw",
|
||||
"app_specific_configuration_path": "$HOME/.config/komorebi/applications.json",
|
||||
"cross_monitor_move_behaviour": "Insert",
|
||||
"default_workspace_padding": 15,
|
||||
|
||||
@@ -1302,8 +1302,10 @@ fn main() -> eyre::Result<()> {
|
||||
current_exe.pop();
|
||||
let komorebi_exe = current_exe.join("komorebi");
|
||||
|
||||
let term_program = std::env::var("TERM_PROGRAM").unwrap_or_default();
|
||||
|
||||
println!(
|
||||
"\nPlease grant Accessibility permissions to \"{}\"",
|
||||
"\nPlease grant Accessibility permissions to \"{}\" and \"{term_program}\"",
|
||||
komorebi_exe.display()
|
||||
);
|
||||
println!("Accessibility permissions are required for komorebi to to manage windows");
|
||||
@@ -1319,7 +1321,7 @@ fn main() -> eyre::Result<()> {
|
||||
std::io::stdin().read_line(&mut input)?;
|
||||
|
||||
println!(
|
||||
"Please grant Screen Recording permissions to \"{}\"",
|
||||
"Please grant Screen Recording permissions to \"{}\" and \"{term_program}\"",
|
||||
komorebi_exe.display()
|
||||
);
|
||||
println!(
|
||||
|
||||
Reference in new issue
Block a user