From 72d760a527c38d2e481f7b3204924ab53741e3a8 Mon Sep 17 00:00:00 2001
From: Joseph Hunkeler <jhunkeler@gmail.com>
Date: Wed, 25 Mar 2026 09:56:35 -0400
Subject: Update README.md

---
 README.md | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 81 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 3c75774..474d889 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,83 @@
 # do
 Minimal make-ish command runner
+
+## Installation
+
+```shell
+mkdir build
+cd build
+cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local
+make
+make install
+```
+
+## Doing things
+
+Running `do` without arguments will look for a `dofile` in the current directory, and run the `default` target automatically.
+
+**dofile**:
+```
+default:
+    echo "default target executed"
+```
+
+__Output__:
+
+```
+==> Running target default
+default target executed
+```
+
+`do` supports targets with dependencies.
+
+```
+hello:
+    echo "hello world"
+
+default: hello
+    echo "default target executed"
+```
+
+
+__Output__:
+
+```
+==> Running target hello
+hello world
+==> Running target default
+default target executed
+```
+
+You can `include` other `dofile`s as well.
+
+*dofile_hello*:
+```
+hello:
+    echo "hello"
+```
+
+*dofile_world*:
+```
+include dofile_hello
+
+world: hello 
+    echo "world"
+```
+
+*dofile*:
+```
+include dofile_world
+
+default: world
+    echo "default target executed"
+```
+
+__Output__:
+```
+==> Running target hello
+hello
+==> Running target world
+world
+==> Running target default
+default target executed
+```
-- 
cgit