abg

commit bc40b8d12436455ef93ce551b9538b171972b734
parent 9c637cf026a43c13ea91735afd6491675f0a687f
Author: Andrew Laack <andrew@laack.co>
Date:   Fri, 18 Sep 2026 00:14:13 -0500

Makefile respects prefix dir, added installation instructions in readme.

Diffstat:
M
Makefile
 | 
6
+++---
M
README
 | 
27
++++++++++++++++++++++-----

2 files changed, 25 insertions(+), 8 deletions(-)
diff --git a/Makefile b/Makefile
@@ -12,10 +12,10 @@ release-build: build
 
 man:
 	mkdir -p ${MANPREFIX}/man1
-	sed "s/VERSION/${VERSION}/g" < docs/abg.1 > ${DESTDIR}${MANPREFIX}/man1/abg.1
-	chmod 644 ${DESTDIR}${MANPREFIX}/man1/abg.1
+	sed "s/VERSION/${VERSION}/g" < docs/abg.1 > ${MANPREFIX}/man1/abg.1
+	chmod 644 ${MANPREFIX}/man1/abg.1
 install: release-build man
-	cp abg.out /usr/local/bin/abg
+	cp abg.out ${PREFIX}/bin/abg
 clean:
 	rm *.out
 
diff --git a/README b/README
@@ -1,11 +1,23 @@
 abg - animated background
 =========================
-A program that executes Prim's algorithm, rendering each step using raylib, set as an X11 background.
+A program that executes Prim's algorithm, rendering each step using raylib, set
+as an X11 background.
 
 
 Requirements
 ============
-X11, raylib, g++, make
+C++ compiler, X11, raylib, make
+
+
+Installation
+============
+Edit config.mk to match your local setup if necessary for building (abg will be
+installed into /usr/local/bin by default).
+
+Then run the following command to build and install abg:
+    make install
+
+(the above command may require root, depending on the installation location)
 
 
 Usage
@@ -15,12 +27,17 @@ Usage
     Optional arguments:
       -h, --help     shows help message and exits
       -v, --version  prints version information and exits
-      --vertices     number of vertices in the graph [nargs=0..1] [default: 200]
-      -s, --sleep    amount of time to sleep between traversals [nargs=0..1] [default: 1]
-      -e, --edges    number of edges in the graph [nargs=0..1] [default: 1000]
+      --vertices     number of vertices in the graph
+      -s, --sleep    amount of time to sleep between traversals
+      -e, --edges    number of edges in the graph
 
 
 Examples
 ========
     abg --edges 50 --vertices 10
     abg --edges 1500 --vertices 1000
+
+
+Configuration
+=============
+The configuration of abg is done via modifying the source code.