Update README: Add Installation and Setup Instructions #2135
Conversation
… custom build logic to `build.gradle.kts` for creating JAR files.\n- Integrated publishing task for deployment readiness.\n- Enhanced compatibility with Java 1.8 using compiler options.
- Added detailed steps for building, packaging, and running the application. - Included instructions for testing and publishing tasks using Gradle. - Ensured clarity for contributors and users in README.
- Added detailed steps for building, packaging, and running the application. - Included instructions for testing and publishing tasks using Gradle. - Ensured clarity for contributors and users in README.
… custom build logic to `build.gradle.kts` for creating JAR files.\n- Integrated publishing task for deployment readiness.\n- Enhanced compatibility with Java 1.8 using compiler options.
- Added detailed steps for building, packaging, and running the application. - Included instructions for testing and publishing tasks using Gradle. - Ensured clarity for contributors and users in README.
There was a problem hiding this comment.
Should this binary be included?
|
|
||
| To execute the application, run: | ||
|
|
||
| java -jar build/libs/maestro-0.1.0.jar |
There was a problem hiding this comment.
Why this route over the one that's in the maestro script in the root directory?
(Not saying this is wrong - I genuinely don't know which route has what tradeoffs)
There was a problem hiding this comment.
Because it specifies including libraries and the version to run so that subsequently when there is an update the readme will be updated to which version is in vogue
There was a problem hiding this comment.
But running the ./maestro script will build and run the current version of the code and not require the readme update, no?
| implementation("org.jetbrains.kotlin:kotlin-stdlib") | ||
| implementation("com.squareup.okhttp3:okhttp:4.9.2") | ||
| implementation("com.google.protobuf:protobuf-java:3.17.3") | ||
| testImplementation("org.jetbrains.kotlin:kotlin-test") | ||
| testImplementation("junit:junit:4.13.2") |
There was a problem hiding this comment.
This isn't my area of expertise, but from looking at other bits of code, I think there's a pattern of tracking dependencies via aliases to the toml.
|
|
||
| To run all tests, execute: | ||
|
|
||
| ./gradlew test |
There was a problem hiding this comment.
Weirdly, I'm not certain that this actually does run all of the tests 😂
Overview
This PR updates the README file to include detailed installation and setup instructions for Maestro.
Details
Related Issue
This PR addresses issue # by providing users with clear setup guidance.
Testing
Additional Notes
Please review and provide feedback on the structure of the new sections.