Skip to content

Commit 3d5d9c1

Browse files
committed
Update codegen readme
1 parent 8fca1b3 commit 3d5d9c1

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -125,11 +125,11 @@ id = 9670971
125125
- `typescript`: boolean (optional)
126126
- Generate a Typescript definition file.
127127
- `style`: "flat" | "nested" (optional)
128-
- The code-generation style to use. Defaults to `flat`. If you would like to have an experience similar to [Tarmac](https://github.com/rojo-rbx/tarmac), use `nested`.
128+
- The code-generation style to use. Defaults to `flat`, which makes accessing assets feel like writing file paths. You may consider using `nested` if you are not a TypeScript user, however, as Luau does not support string template literals.
129129
- `output_name`: string (optional)
130130
- The name for the generated files. Defaults to `assets`.
131131
- `strip_extension`: boolean (optional)
132-
- Whether to strip the file extension. Defaults to `false`. If you would like to have an experience similar to [Tarmac](https://github.com/rojo-rbx/tarmac), use `true`.
132+
- Whether to strip the file extension. Defaults to `false`. We recommend `true` if using the `nested` codegen style.
133133

134134
#### ExistingAsset
135135

0 commit comments

Comments
 (0)