From c97378414e6e38ad7a2315d62ba36a3d82f423be Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Tue, 24 Feb 2026 22:28:23 -0500 Subject: [PATCH] README.rst: add one for Codeberg's sake --- README.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.rst 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 +`_, but syntactically compatible +with `Dash `_ 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. -- 2.51.0