commit 0823760b84b9ca941765536a52175b4c9c880472
parent 6a99e03cef31d0dcc717c4f6b7a39a9d074faca2
Author: Jacob R. Edwards <jacobouno@protonmail.com>
Date: Fri, 29 Jan 2021 16:59:44 -0800
Make the README more legible
Not too much of it's content actually changed, mostly trying to
improve awkward sentances.
Diffstat:
| M | README | | | 39 | ++++++++++++++++----------------------- |
1 file changed, 16 insertions(+), 23 deletions(-)
diff --git a/README b/README
@@ -1,29 +1,22 @@
OpenBSD rc files and scripts
-While primarily focused on OpenBSD these utilities are common on many
-unix-like systems and therefor most things should work.
+Most scripts work with only standard UNIX utilities along with
+plan9's rc shell, although note that env(1) and awk(1) must be
+installed to /usr/bin and rc to /usr/local/bin for shebangs to work
+without modification. Also execv(3) is assumed to handle at least
+one argument for some scripts.
-The configuration files try to be placed in ~/.config which should be
-what the XDG_CONFIG_HOME environment variable is set to.
+The walt script requires a specially formatted thesaurus which may
+be generated from my moby repository, likewise wdef requires a
+dictionary available in my opted repository.
-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.
+Also note the xorg module requires many programs which may not be
+installed, if you want my builds of dwm and slstatus see my
+repositories of the same name.
-Furthermore for the dictionary and thesaurus scripts to work you must
-install the appropriate files via my `cvsopted' and `csvmoby'
-respectively. These scripts should probably be repositories of their
-own and I will do that at some point.
+There are two make(1) targets, install and uninstall, which use GNU
+stow(1) to manage modules which can optionally limited to those
+listed in make(1)'s MODULES variable, for example, to install only
+the vi and ksh modules:
-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
+$ make MODULES='vi ksh' install
