Skip to content

Commit ee3c5de

Browse files
author
luigi
committed
modify read me
1 parent 4e7fd91 commit ee3c5de

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

codegen/smithy-kotlin-codegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/service/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ While Ktor is the default backend, the architecture is framework-agnostic, allow
2929
- `ServiceStubGenerator.kt` – abstract service stub generator file.
3030
- `ServiceTypes.kt` – file that includes service component symbols.
3131
- `utils.kt` – utilities file.
32+
- `BuildScriptGenerator.kt` – build scripts generator file.
3233

3334
### Testing
3435

codegen/smithy-kotlin-codegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/service/docs/GettingStarted.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,22 @@ Run:
136136
gradle build
137137
```
138138

139+
⚠️ Running gradle build will delete the previous build output before creating a new one.
140+
141+
If you want to prevent accidentally losing previous build, use the provided scripts instead:
142+
143+
Linux / macOS:
144+
```bash
145+
chmod +x build.sh
146+
./build.sh
147+
```
148+
149+
Windows:
150+
```bash
151+
icacls build.bat /grant %USERNAME%:RX
152+
.\build.bat
153+
```
154+
139155
If you want to clean previously generated code:
140156
```bash
141157
gradle clean

0 commit comments

Comments
 (0)