diff --git a/README.md b/README.md index 1f851255d546eaaaade9ba597baf7e153b23fde5..f64ebc11a21aa42bfa12592870484a86bd07f3b2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,10 @@ # squeekboard-terminal-layout-generator -A simple script that will generate "terminal" layouts from "normal" layouts for squeekboard \ No newline at end of file +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 + +terminal_layout.sh ALL => generate all terminal layouts + +Use with caution: it will overwrite any single/ALL existing file for terminal layouts