diff options
| author | Joseph Hunkeler <jhunkeler@gmail.com> | 2026-03-25 09:56:35 -0400 |
|---|---|---|
| committer | Joseph Hunkeler <jhunkeler@gmail.com> | 2026-03-25 09:56:35 -0400 |
| commit | 72d760a527c38d2e481f7b3204924ab53741e3a8 (patch) | |
| tree | 7d7e0bd6f482cc25af20f8ff08940cf7623d776e /README.md | |
| parent | 7d293e63f117e439f85fbce4caf728f17c6d6eec (diff) | |
| download | do-72d760a527c38d2e481f7b3204924ab53741e3a8.tar.gz | |
Update README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 81 |
1 files changed, 81 insertions, 0 deletions
@@ -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 +``` |
