dep

commit e3eab5f4c6d9ea58bcc73dbdca7b7cab5163a0f7
parent c15c0d9521e687d18e7206c2f3f8f80bf4a74280
Author: finwo <finwo@pm.me>
Date:   Sat, 28 Jan 2023 17:05:40 +0100

Added basic readme and global help fix

Diffstat:
M
Makefile
 | 
6
+++++-
A
README.md
 | 
46
++++++++++++++++++++++++++++++++++++++++++++++
A
README.md.html
 | 
33
+++++++++++++++++++++++++++++++++
M
dist/dep
 | 
2
+-
M
src/command/help/topic/global.txt
 | 
2
+-

5 files changed, 86 insertions(+), 3 deletions(-)
diff --git a/Makefile b/Makefile
@@ -17,6 +17,10 @@ dist/$(TARGET): $(SRC)
 install: dist/$(TARGET)
 	install "dist/$(TARGET)" "$(DESTDIR)/bin"
 
+README.md: README.md.html
+	$(PREPROCESS) -D __NAME=$(TARGET) $< > "$@"
+
 .PHONY: clean
 clean:
-	rm -f $(TARGET)
+	rm -rf dist
+	rm -f README.md
diff --git a/README.md b/README.md
@@ -0,0 +1,46 @@
+dep
+======
+
+General purpose dependency manager, with a slight focus on static C libraries
+
+Usage
+-----
+
+```
+Usage: dep [global options] <command> [options] [-- ...args]
+
+Global options:
+  n/a
+
+Commands:
+  a(dd)           Add a new dependency to the project
+  i(nstall)       Install all the project's dependencies
+  h(elp) [topic]  Show this help or the top-level info about a command
+
+Help topics:
+  global          This help text
+  add             More detailed explanation on the add command
+  install         More detailed explanation on the install command
+```
+
+Installation
+------------
+
+To install dep, simply download [dist/dep](dist/dep) and place it in your
+`/usr/local/bin` directory or anywhere else that's included in your `$PATH`.
+
+If you want to build it from source, clone the repository and run the following
+commands:
+
+```sh
+make
+sudo make install
+```
+
+To install the binary in a location other that `/usr/local/bin`, pass the
+`DESTDIR` definition to the `make install` command (default: `/usr/local`).
+
+License
+-------
+
+This project falls under the [MIT license](LICENSE)
diff --git a/README.md.html b/README.md.html
@@ -0,0 +1,33 @@
+__NAME
+======
+
+General purpose dependency manager, with a slight focus on static C libraries
+
+Usage
+-----
+
+```
+<!-- #include "src/command/help/topic/global.txt" -->
+```
+
+Installation
+------------
+
+To install __NAME, simply download [dist/dep](dist/dep) and place it in your
+`/usr/local/bin` directory or anywhere else that's included in your `$PATH`.
+
+If you want to build it from source, clone the repository and run the following
+commands:
+
+```sh
+make
+sudo make install
+```
+
+To install the binary in a location other that `/usr/local/bin`, pass the
+`DESTDIR` definition to the `make install` command (default: `/usr/local`).
+
+License
+-------
+
+This project falls under the [MIT license](LICENSE)
diff --git a/dist/dep b/dist/dep
@@ -3,7 +3,7 @@ cmds=("")
 declare -A help_topics
 
 read -r -d '' help_topics[global] <<- EOF
-Usage: ${NAME} [global options] <command> [options] [-- ...args]
+Usage: dep [global options] <command> [options] [-- ...args]
 
 Global options:
   n/a
diff --git a/src/command/help/topic/global.txt b/src/command/help/topic/global.txt
@@ -1,4 +1,4 @@
-Usage: ${NAME} [global options] <command> [options] [-- ...args]
+Usage: __NAME [global options] <command> [options] [-- ...args]
 
 Global options:
   n/a