Miroirs/pinnacle
1
0
Fork 0
mirror of https://github.com/pinnacle-comp/pinnacle.git synced 2025-01-14 08:01:14 +01:00
Code Issues Projects Releases Packages Wiki Activity

Update README

Browse source
This commit is contained in:
Ottatop 2023-09-08 00:23:19 -05:00
parent 60bdf8763c
commit 6c7385e5b8
1 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -75,7 +75,8 @@ For NixOS users, there is a provided [`shell.nix`](shell.nix) file that you can
<sup>flake soon:tm:</sup> <sup>flake soon:tm:</sup>
# Running # Running
> :information_source: Before running, read the information in [Configuration](#configuration). > [!IMPORTANT]
> Before running, read the information in [Configuration](#configuration).
After building, run the executable located in either: After building, run the executable located in either:
```sh ```sh
@ -107,7 +108,7 @@ pass in the `--force` flag to continue. *This is not recommended.*
> In that case, kill the compositor using the keybind defined in > In that case, kill the compositor using the keybind defined in
> `kill_keybind` (default <kbd>Ctrl</kbd><kbd>Alt</kbd><kbd>Shift</kbd> + <kbd>Esc</kbd>) and set `command` properly. > `kill_keybind` (default <kbd>Ctrl</kbd><kbd>Alt</kbd><kbd>Shift</kbd> + <kbd>Esc</kbd>) and set `command` properly.
> [!INFO] > [!NOTE]
> Pinnacle will open a socket in the `/tmp` directory. > Pinnacle will open a socket in the `/tmp` directory.
> If for whatever reason you need the socket to be in a different place, set `socket_dir` in > If for whatever reason you need the socket to be in a different place, set `socket_dir` in
> your `metaconfig.toml` file to a directory of your choosing. > your `metaconfig.toml` file to a directory of your choosing.