commit 144e96a6ace38d2a62b663655ea7f85f8b6b45d3
parent c6b418d3b3377bc987e8e36de99f66a15c44451a
Author: Jacob R. Edwards <jacobouno@protonmail.com>
Date: Thu, 18 Feb 2021 15:10:41 -0800
Simplify and update the README
The previous version was getting messy with the new information I
carelessly appended to it over time, this one gives the important
information and leaves it at that (although I say that, it's still
probably too verbose).
Diffstat:
| M | README | | | 41 | ++++++++++++++--------------------------- |
1 file changed, 14 insertions(+), 27 deletions(-)
diff --git a/README b/README
@@ -1,32 +1,19 @@
-OpenBSD rc files and scripts
+OpenBSD [and UNIX] system configurations
-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.
+There are two packages, local, for user-specific modules, and global,
+for system-wide modules. In each package there are multiple modules
+such as ksh for ksh(1) related files and vi for vi(1) related files.
-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.
+To select packages use the PKGS variable, e.g. make PKGS=local, to
+select modules use the MODULES variable, e.g. make MODULES=vi. By
+default the selected modules from the selected packages are installed
+using cast(1) (see my cast project), but you may use GNU stow(1)
+on the local package by defining STOW, e.g. make STOW=1.
-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.
+An example to install only the vi and ksh modules from the local
+package:
-There are two make(1) targets, install and uninstall, which use
-cast(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:
+ $ make PKGS=local MODULES='vi ksh'
-$ make MODULES='vi ksh' install
-
-You may also install the global configurations by selecting the
-`global' package (e.g. make PKGS=global) although you should look
-over it first, this stuff is mostly OpenBSD specific and not user
-agnostic, that is, it gives the user `jacob' alot of power (see
-doas.conf).
-
-Note that cast(1) is not likely in your packages, to install it
-please see my cast repository wherever you found this one. You may
-also use GNU stow(1) by defining STOW, e.g. `make STOW=1'.
+Note that you may omit 'PKGS=local' since PKGS is defined as local
+by default.
