commit 3cf80e4b3e2dd1b770182ab689dcc69e00bd97f9
parent c34520895c0bcf96d93caeb125368d250267b5e2
Author: Drew DeVault <sir@cmpwn.com>
Date: Tue, 20 Apr 2021 14:32:32 -0400
os, os::exec: add READMEs
Diffstat:
2 files changed, 12 insertions(+), 0 deletions(-)
diff --git a/os/README b/os/README
@@ -0,0 +1,7 @@
+The os module provides access to resources from the host operating system,
+particularly to the filesystem and standard I/O. [[cwd]] provides an
+implementation of [[fs::fs]] which is backed by the host filesystem, and this
+module provides equivalents of various [[fs]] functions which infer the current
+working directory as the fs parameter. This module also provides various
+non-filesystem related features from the host, such as the hostname, environment
+variables, and so on.
diff --git a/os/exec/README b/os/exec/README
@@ -0,0 +1,5 @@
+os::exec handles the execution of arbitrary commands. A programmer who needs to
+spawn an external command will usually utilize [[cmd]] to obtain a [[command]]
+instance (possibly using functions like [[setenv]] to customize it), then
+[[start]] to execute it and obtain a [[process]] (or, [[exec]] to replace the
+current process with it), then [[wait]] or [[peek]] to check in on its status.
