Enhanced documentation.
the build was successful Details

This commit is contained in:
tastytea 2019-01-01 09:07:39 +01:00
父節點 7c13f23d3c
當前提交 6a67553d61
簽署人: tastytea
GPG Key ID: CFC39497F1B26E07
共有 1 個文件被更改,包括 5 次插入3 次删除

查看文件

@ -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