From 6a67553d61682eb1110631a484cc01d826f34dd5 Mon Sep 17 00:00:00 2001 From: tastytea Date: Tue, 1 Jan 2019 09:07:39 +0100 Subject: [PATCH] Enhanced documentation. --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2c47f33..046dfad 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,15 @@ scripts. By default it uses g++. It compiles the source file, stores the binary in `${XDG_CACHE_HOME}/compilescript/` and executes it. If the binary in cache is -newer than the source file, the compilation is skipped. You can delete old cache -files with `--cleanup`. +newer than the source file, the compilation is skipped. ## Usage Use `#!/usr/bin/env compilescript` as shebang and write the compiler arguments in the second line with the prefix: `//compilescript:`. +You can delete old cache files with `--cleanup`. + ### Example ```C++ @@ -30,7 +31,8 @@ int main(int argc, char *argv[]) ## Configuration -The configuration file is in `${XDG_CONFIG_HOME}/compilescript.cfg`. +The configuration file is in `${XDG_CONFIG_HOME}/compilescript.cfg`. It will be +generated on first run. ### Example config