commit 4d0d4569d0165a5eb16f2c710fcd30cdb8a95698 parent d831569e4cc74a471b7d85d3f0e5f77b1b8f8614 Author: Jacob R. Edwards <jacobouno@protonmail.com> Date: Wed, 18 Nov 2020 18:38:49 -0800 Update README Add installation examples and information and a list of dependencies for the scripts module. Diffstat:
| M | README | | | 26 | +++++++++++++++++++++++--- |
1 file changed, 23 insertions(+), 3 deletions(-)
diff --git a/README b/README @@ -1,4 +1,24 @@ -OpenBSD R.C. +OpenBSD rc files and scripts -This repository contains configuration files for OpenBSD -although they probably work on most unix-like systems. +While primarily focused on OpenBSD these utilities are common on many +unix-like systems and therefor most things should work. + +The configuration files try to be placed in ~/.config which should be +what the XDG_CONFIG_HOME environment variable is set to. + +For the scripts module to function the following criteria must be met: +- Standard unix utilities must be installed and in PATH. +- awk(1) is installed at /usr/bin/awk. +- dash(1) installed and in PATH. +- env(1) is installed at /usr/bin/env. +- rc(1) is installed at /usr/local/bin/rc. + +To install all modules simply call make(1): +$ make + +To uninstall them run the uninstall target: +$ make uninstall + +To work only on select modules set the MODULES variable, in this case +only graphical modules: +$ make MODULES='xorg mpv zathura vimb' uninstall