summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorseth <[email protected]>2022-08-06 04:31:48 -0400
committerseth <[email protected]>2022-08-06 04:31:48 -0400
commitf36a74c805cdbacaa671fd4019204ed3889bae55 (patch)
treeefa43ecad4ac5e0e6b4c45ea6766c81d8939e05a /README.md
parent2d53cc8a2ba81ca74ec8e2cb587bee5bd5f43e63 (diff)
stop using platform, start using subprocess
also did some more refactoring :trollfig:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/README.md b/README.md
index c20e341..b9433a0 100644
--- a/README.md
+++ b/README.md
@@ -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 :)