Skip to content

Commit 2991f36

Browse files
committed
add curl install script for signls
1 parent 2bd0064 commit 2991f36

2 files changed

Lines changed: 437 additions & 3 deletions

File tree

content/signls.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ It takes inspiration from [Orca](https://100r.co/site/orca.html) and [Nodal](htt
4141

4242
**Signls** is available for **Linux**, **macOS** and **Windows**.
4343

44-
[Download the last release](https://emprcl.itch.io/signls) for your platform.
44+
[Download the last release](https://github.com/emprcl/signls/releases) for your platform.
4545

4646
### Linux & macOS
4747

@@ -85,10 +85,18 @@ You can also [build it yourself](https://github.com/emprcl/signls?tab=readme-ov-
8585

8686
Hit `?` to see all keybindings. `esc` to quit.
8787

88+
### Files location
89+
90+
Signls stores its _config.json_ and bank files in your user config directory:
91+
92+
- **Linux / macOS**: `~/.config/emprcl/signls/` (or `$XDG_CONFIG_HOME/emprcl/signls/`)
93+
- **Windows**: `%AppData%\emprcl\signls\`
94+
95+
You can override either with an explicit path using the `--config` and `--bank` flags.
8896

8997
### Keyboard mapping
9098

91-
Keys mapping is fully customizable. After running signls for the first time, a _config.json_ is created.
99+
Keys mapping is fully customizable. After running signls for the first time, a _config.json_ is created in your [config directory](#files-location).
92100
You can edit all the keys inside it.
93101

94102
You can select one of the default keyboard layouts available:
@@ -376,7 +384,7 @@ For example, if you set the **velocity** to _80+5_, the random value will be pic
376384
377385
### Bank
378386

379-
You manage your projects using a **bank**. When you start the program, you can provide a **bank** JSON file, or if none is provided, a default file (_default.json_) will be created or loaded automatically. Each bank can store up to **32 grids**.
387+
You manage your projects using a **bank**. When you start the program, you can provide a **bank** JSON file, or if none is provided, a default file (_default.json_) will be created or loaded automatically in your [config directory](#files-location). Each bank can store up to **32 grids**.
380388

381389
```sh
382390
./signls --bank my-grids.json

0 commit comments

Comments
 (0)