← Back to davo.co
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Faulkner <[email protected]>2026-08-06 03:15:42 -0500
committerDavid Faulkner <[email protected]>2026-08-06 03:15:42 -0500
commit462fbecd5c60f5473ce808bd2ff46aa27daa1ae9 (patch)
tree880dec0eac9c9906a7bf4d2783ab7e2e01fe6002
parent85c77a80f1baa924535c3e1455fe4d9df7c13a6c (diff)
docs(readme): consolidate build and execution sections and update HTTPS clone URL
- Add HTTPS clone URL for git.davo.co - Document hardened build flags and optimization features - Combine Build and Execution instructions into a single workflow section
-rw-r--r--README.md35
1 files changed, 33 insertions, 2 deletions
diff --git a/README.md b/README.md
index 4245de1..e7c14dd 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,8 @@ A clean, minimalist, robust C utility designed to automate Debian-based Linux sy
- **Automated APT Maintenance:** Updates repository indices, checks for upgradeable packages, and runs `apt full-upgrade` only when updates exist.
- **Dependency & Cache Cleanup:** Automatically purges unused dependencies and lingering configuration files (`apt autoremove --purge`) and empties cached installer packages (`apt clean`).
- **User Cache Housekeeping:** Safely cleans desktop thumbnail caches and user screenshot directories without failing if the directories are empty.
-- **Robust POSIX C Implementation:** Built using strict standard C (`-std=c11`, POSIX 2008) with explicit bounds checking on formatted buffers and process status checking (`WIFEXITED`, `WEXITSTATUS`).
+- **Robust POSIX C Implementation:** Built using strict standard C (`-std=c11`, POSIX 2008) with explicit bounds checking on formatted buffers and POSIX exit status inspection (`WIFEXITED`, `WEXITSTATUS`).
+- **Hardened & Optimized Build:** Compiled with `-O3`, `-flto`, `-march=native`, stack protection (`-fstack-protector-strong`), runtime buffer fortification (`-D_FORTIFY_SOURCE=2`), and strict warning checks (`-Wall -Wextra -Wpedantic -Werror`).
- **Clean Terminal Output:** Indents subprocess output using `sed` for a clear, readable terminal log.
---
@@ -24,14 +25,44 @@ This utility requires a **Debian-based distribution** (Debian, Ubuntu, Linux Min
---
+## Repository Access & Cloning
+
+Clone the repository directly from the cgit web frontend:
+
+```bash
+git clone [https://git.davo.co/ud.git](https://git.davo.co/ud.git)
+```
+
+---
+
## Build Instructions
To compile the executable using `make`:
```bash
-# Build the utility (uses gcc with -Wall -Wextra -Wpedantic -O2 -std=c11)
+# Build the utility with maximum optimization and hardening flags
make
+# Install the binary to ~/.local/bin
+make install
+
# Clean build artifacts
make clean
+
+# Uninstall the binary from ~/.local/bin
+make uninstall
+```
+
+---
+
+## Execution Instructions
+
+Run the utility directly from your terminal:
+
+```bash
+# Run directly from the source directory
+./ud
+
+# Or run from anywhere if ~/.local/bin is in your $PATH
+ud
```