chore: add readme

ErrorNoInternet · Aug 20, 2024 · 1451342 · 1451342
1 parent dc7d902
commit 1451342
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,20 @@
+# asmfetch
+
+A fetch tool written in x86-64 assembly. Runs in under 250 microseconds.
+
+There is almost no error handling, and lots of things may break.
+Please report any bugs you find.
+
+![Preview](/asmfetch.png)
+
+## Usage
+
+```
+$ gcc -nostdlib asmfetch.S -o asmfetch
+$ ./asmfetch
+```
+
+## Customization
+
+It wasn't designed to be very customizable, but you can tweak one or two things
+(including the logo) by modifying the includes in `asmfetch.S`.
diff --git a/asmfetch.S b/asmfetch.S
@@ -23,6 +23,7 @@
 .include "system.S"
 .include "uptime.S"
 
+# customization
 .include "kernel/without_machine.S"
 .include "logo/fedora.S"
 .include "shell/path.S"

diff --git a/asmfetch.png b/asmfetch.png