Skip to content

Commit 2a8d261

Browse files
authored
update README output dir (#283)
1 parent 7b1f0c1 commit 2a8d261

1 file changed

Lines changed: 16 additions & 1 deletion

File tree

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,14 @@ Then, you can use the versions.yaml in the `generate-project` command:
5050
- `--develocity-url`: Specify Develocity URL
5151
- `--versions-file`: Path to a custom YAML file with dependency versions
5252
- `--project-name`: Name of the project
53+
- `--output-dir`: Output directory for the generated project. For `kts` and `groovy`, files are written directly there. For `both`, `project_kts` and `project_groovy` subdirectories are created inside it.
5354
- `--room-database`: Enable Room database generation (default: false). Only for Android projects.
5455
- `--android-kotlin-multiplatform-library`: For Android projects, generate Android library modules with `com.android.kotlin.multiplatform.library` instead of `com.android.library` (default: false).
5556

5657
Android projects use the default AGP version from `Versions()` unless you override it in `--versions-file`.
5758

59+
By default, projects are generated under `projects_generated/<projectName>/project_kts` or `project_groovy`. When `--output-dir` is provided, single-language projects are written directly to that directory.
60+
5861
#### Example: Generate a project with custom options
5962
```bash
6063
./projectGenerator generate-project --shape rhombus --modules 50 --layers 4 --language both --type jvm --classesModule 10 --classesModuleType random --typeOfStringResources large --generateUnitTest --gradle gradle_8_9 --develocity --versionsFile ./my_versions.yaml
@@ -75,7 +78,7 @@ ProjectGenerator(
7578
layers = 5,
7679
generateUnitTest = true,
7780
gradle = GradleWrapper(Gradle.GRADLE_9_3_1),
78-
path = file.path
81+
projectRootPath = file.path
7982
).write()
8083

8184
```
@@ -121,6 +124,17 @@ Two projects will be generated using Kotlin DSL and Groovy
121124
```kotlin
122125
./projectGenerator generate-project --shape triangle --layers 5 --modules 100 --language groovy
123126
```
127+
128+
## `output-dir`
129+
Optional output directory for the generated project.
130+
131+
- For `--language kts` and `--language groovy`, project files are written directly into the provided directory.
132+
- For `--language both`, two subdirectories are created inside the provided directory: `project_kts` and `project_groovy`.
133+
134+
##### Example
135+
```kotlin
136+
./projectGenerator generate-project --modules 100 --output-dir .
137+
```
124138
## `type`
125139
Type of project generated:
126140
### `android`
@@ -202,6 +216,7 @@ Gradle used, versions supported:
202216
## Versions
203217
Example output versions.yaml:
204218
```yaml
219+
gradle: GRADLE_9_4_0
205220
project:
206221
develocity: 4.1
207222
jdk: 23

0 commit comments

Comments
 (0)