From: Michael Orlitzky <michael@orlitzky.com>
Date: Wed, 25 Feb 2026 03:28:23 +0000 (-0500)
Subject: README.rst: add one for Codeberg's sake
X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=c97378414e6e38ad7a2315d62ba36a3d82f423be;p=shell.d.git

README.rst: add one for Codeberg's sake
---

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..09178c9
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,28 @@
+Overview
+========
+
+My personal shell configuration. Used IRL with `BASH
+<https://www.gnu.org/software/bash/>`_, but syntactically compatible
+with `Dash <https://git.kernel.org/pub/scm/utils/dash/dash.git>`_ as
+well.
+
+
+Usage
+=====
+
+Aliases, variables, and functions are organized into ``*.sh``
+files. The easiest way to use them is to "build" the project with
+
+.. code-block:: console
+
+  $ make
+
+This will concatenate ``*.sh`` into one big file called ``all``. Now
+in your ``~/.bashrc`` or equivalent, append the line
+
+.. code-block:: shell
+
+  . /path/to/shell.d.git/all
+
+That's it. Or if you would prefer to use only a subset of the ``*.sh``
+files, only source the ones you need.