README (1574B)
1 # sent-tools 2 3 A small toolkit of shell scripts for compiling suckless sent slideshows. 4 5 ## Scripts 6 7 - `compile-sent-tables.sh` - Converts Markdown tables in tables/ to images/tables 8 - `compile-sentspec.sh` - Compiles .sentspec to .sent (see -h for more info) 9 - `sent-dev.sh` - Developer helper for automated workflow (requires `tmux`, `entr`). 10 - `compile-sentspec-wrapper.sh` - a helper script which allows to use a `config` 11 12 **Important:** 13 14 Scripts have `.sh` in the repo but are intended to be called without `.sh` after installation. 15 16 ## Dependencies 17 18 - Required: 19 `md-table-to-jpg`, `curl`, `convert`, `identify`, `mktemp`, `cut`, `grep`, `awk`, `sha256sum` (or `sha256`), `stat` 20 21 - For developer workflows: 22 `tmux`, `entr` 23 24 - Optional: 25 Config file providing a `compile_sentspec_args()` function 26 27 ## Installation 28 29 1. Clone this repository: 30 ``` 31 git clone https://some-url/sent-tools.git 32 cd sent-tools 33 ``` 34 35 2. Run the install script to symlink scripts (without `.sh`) to `~/bin`: 36 ``` 37 ./install.sh 38 ``` 39 If you want to symlink to a different directory in your `PATH`, provide it: 40 ``` 41 ./install.sh /desired/path/bin 42 ``` 43 3. Make sure `~/bin` (or your chosen directory) is in your `PATH`: 44 ``` 45 export PATH="$HOME/bin:$PATH" 46 ``` 47 Add that line to your `.bashrc` or `.zshrc` for persistence. 48 49 4. Optional: copy/edit `config.example` to `your-project/config` 50 51 ## Usage 52 53 Run tools using their name (without `.sh`), for example: 54 55 ``` 56 compile-sentspec input.sentspec > output.sent 57 compile-sent-tables 58 sent-dev input.sentspec 59 ```