diff --git a/README.md b/README.md index f64ebc11a21aa42bfa12592870484a86bd07f3b2..4253bb8bc64528ff573f63778752cab263db5a50 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,19 @@ A simple script that will generate "terminal" layouts from "normal" layouts for squeekboard -## Usage : -terminal_layout.sh <file.yaml> => generate a terminal layout from this file +## Usage -terminal_layout.sh ALL => generate all terminal layouts +### On first run (or to refresh source keyboard layouts) + +Run `get_normal_keyboards.sh` + +### Generate one or all layouts + +`terminal_layout.sh <file.yaml>` => generate a terminal layout from this file + +`terminal_layout.sh ALL` => generate all terminal layouts Use with caution: it will overwrite any single/ALL existing file for terminal layouts + +Source directory: `normal_layout` +Target directory: `terminal_layout`