diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..c20e341 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# hiccup + +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`. + +## how to install +hiccup only needs one command to install :) +```sh +make install +``` + +and to uninstall: +```sh +make uninstall +``` |