diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 12 insertions, 2 deletions
@@ -3,8 +3,18 @@ hiccup is a python script that attempts to upgrade your system with multiple package managers. ## how it works -hiccup reads from `$XDG_CONFIG_HOME/hiccup/config.json`. this file specifies distros (by their freedesktop id), shell plugin -managers, and other package managers, paired with a command that runs an update - see `default-config.json`. +hiccup reads from `$XDG_CONFIG_HOME/hiccup/config.json`. this file must contain 5 objects: + +- `system_update_cmds` +- `extra_cmds` +- `clean_cmds` +- `shell_plugin_cmds` +- `other_cmds` + +the value for most keys will be run with `bash -c`, but values in `system_update_cmds` and `clean_cmds` +will run with `sudo bash -c` and values in `shell_plugin_cmds` will run with name of the shell specified. + +see `default-config.json` for example ## how to install hiccup only needs one command to install :) |