Skip to content

Commit 9b4d7e9

Browse files
committed
docs: update readme
1 parent 41979de commit 9b4d7e9

File tree

1 file changed

+29
-4
lines changed

1 file changed

+29
-4
lines changed

README.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# spc
22

3-
CLI wrapper for the Crestron SIMPL+ Compiler
3+
A better way to compile SIMPL+ files.
44

55
## Usage
66

77
```bash
8-
spc [command] [options] <file> [file...]
8+
spc [command] [options] <file...>
99
```
1010

1111
### Commands
@@ -44,9 +44,34 @@ Precedence (highest to lowest):
4444
3. Global config (`%APPDATA%\spc\config.[yml|json|toml]`)
4545
4. Defaults
4646

47-
### Config File Example (YAML)
47+
### Config File Example
4848

4949
```yaml
50-
compiler_path: "C:\\Program Files (x86)\\Crestron\\Simpl\\SPlusCC.exe"
50+
compiler_path: "C:/Program Files (x86)/Crestron/Simpl/SPlusCC.exe"
5151
target: "4"
52+
out: "build.log"
53+
usersplusfolder:
54+
- "C:/MyCustomSimplPlus"
55+
silent: false
56+
verbose: false
57+
```
58+
59+
```json
60+
{
61+
"compiler_path": "C:/Program Files (x86)/Crestron/Simpl/SPlusCC.exe",
62+
"target": "4",
63+
"out": "build.log",
64+
"usersplusfolder": ["C:/MyCustomSimplPlus"],
65+
"silent": false,
66+
"verbose": false
67+
}
68+
```
69+
70+
```toml
71+
compiler_path = "C:/Program Files (x86)/Crestron/Simpl/SPlusCC.exe"
72+
target = "4"
73+
out = "build.log"
74+
usersplusfolder = ["C:/MyCustomSimplPlus"]
75+
silent = false
76+
verbose = false
5277
```

0 commit comments

Comments
 (0)