Browse Source

Enhanced documentation.

tastytea 2 months ago
parent
commit
6a67553d61
Signed by: tastytea <tastytea@tastytea.de> GPG Key ID: CFC39497F1B26E07
1 changed files with 5 additions and 3 deletions
  1. 5
    3
      README.md

+ 5
- 3
README.md View File

@@ -3,14 +3,15 @@ scripts. By default it uses g++.
3 3
 
4 4
 It compiles the source file, stores the binary in
5 5
 `${XDG_CACHE_HOME}/compilescript/` and executes it. If the binary in cache is
6
-newer than the source file, the compilation is skipped. You can delete old cache
7
-files with `--cleanup`.
6
+newer than the source file, the compilation is skipped.
8 7
 
9 8
 ## Usage
10 9
 
11 10
 Use `#!/usr/bin/env compilescript` as shebang and write the compiler arguments
12 11
 in the second line with the prefix: `//compilescript:`.
13 12
 
13
+You can delete old cache files with `--cleanup`.
14
+
14 15
 ### Example
15 16
 
16 17
 ```C++
@@ -30,7 +31,8 @@ int main(int argc, char *argv[])
30 31
 
31 32
 ## Configuration
32 33
 
33
-The configuration file is in `${XDG_CONFIG_HOME}/compilescript.cfg`.
34
+The configuration file is in `${XDG_CONFIG_HOME}/compilescript.cfg`. It will be
35
+generated on first run.
34 36
 
35 37
 ### Example config
36 38
 

Loading…
Cancel
Save