Skip to content

Commit 09feb80

Browse files
Adding documentation for allowing yaml file as input
1 parent 66ec105 commit 09feb80

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

mkdocs/docs/guides/basics.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ with the config specified either:
2121
script.yaml # Your build settings
2222
```
2323
24-
The name of the final output will be the name of the script file, therefore a script file will
24+
The name of the output binary will be the name of the script file therefore a script file will
2525
always have a 1 to 1 relationship with the linker output, even if multiple sources are specified in
2626
the script file build settings.
2727
@@ -60,6 +60,12 @@ runcpp2 ./script.cpp <any arguments>
6060
int main(int, char**) { std::cout << "Hello World" << std::endl; }
6161
```
6262

63+
### YAML File As Input
64+
65+
!!! info inline end "This requires `v0.4.0` version"
66+
You can also use a YAML file as input. If this is the case, the name of the output
67+
binary will be the name of the YAML file.
68+
6369
---
6470

6571
## Error Feedback
@@ -79,6 +85,8 @@ can be spcified inlined inside a source file or as a separate yaml file in the f
7985

8086
- To specify build config in a dedicated yaml file:
8187
- The yaml file in the same directory and share the same as the source file being run will be used
88+
!!! info inline end "This requires `v0.4.0` version"
89+
- The yaml file must specify at least one source if fed as input
8290
- To specify inline build config inside a source file:
8391
- Put them inside a comment with `runcpp2` at the beginning of the build config
8492
- The inline build config can exist in anywhere of the source file

0 commit comments

Comments
 (0)