From d083c6b39f4d333d5ab0f46d2ac6be53878c2ca6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Berke=20Kocao=C4=9Flu?= <berke.kocaoglu@metu.edu.tr>
Date: Wed, 21 Aug 2024 12:12:17 +0300
Subject: [PATCH] readme: clean up installation & uninstallation sections

---
 README.md | 38 +++++++++++++++-----------------------
 1 file changed, 15 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index 0f20e148..2a72b5b9 100644
--- a/README.md
+++ b/README.md
@@ -13,41 +13,33 @@ Awk, Bash, C , C++, execline, Go, JavaScript, POSIX Shell, Perl, Python, and Rus
 
 ## Installation
 
-To install for your user:
-
 ```sh
-git submodule update --init --recursive
-make install
-```
-
-To install system-wide (recommended):
+git clone https://github.com/XPhyro/scripts.git # clone repository
+git submodule update --init --recursive # initialise dependencies
 
-```sh
-git submodule update --init --recursive
-sudo make install
+make install # install for your user
+sudo make install # or install system-wide (recommended)
 ```
 
-You may change the installation directory by setting `$PREFIX`.
+You may set `$PREFIX` to change the installation directory. By default, it is
+`~/.local` for your user, or `/usr/local` for the system.
+
+After installation, add `$PREFIX/share/scripts/include` to your path. A POSIX
+shell standard library will have been installed here, and will be used by all
+shell scripts.
 
-If you would like to use the provided wrapper scripts, add `$PREFIX/bin/wrapper`
+If you would like to use the provided wrapper scripts, also add `$PREFIX/bin/wrapper`
 to your `$PATH` with higher priority than the locations of the wrapped scripts.
-Some scripts also require `$PREFIX/share/scripts/include` to be in your path.
 
 ## Uninstallation
 
-If you installed for your user:
-
-```sh
-make uninstall
-```
-
-If you installed system-wide:
-
 ```sh
-sudo make uninstall
+make uninstall # if you installed for your user
+sudo make uninstall # if you installed system-wide
 ```
 
-You do not need to re-set `$PREFIX` while uninstalling.
+You do not need to re-set `$PREFIX` while uninstalling. The previously-used
+`$PREFIX` will automatically be used.
 
 If you altered your `$PATH`, you may also wish to undo it.