docs: add READMEs to examples #119
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
qurbonzoda
requested changes
Jun 30, 2023
examples/kotlin-kts/README.md
Outdated
| | --- | --- | | ||
| | `gradle assembleBenchmarks` | Generate and build all benchmarks in the project | | ||
| | `gradle benchmark` | Execute all benchmarks in the project | | ||
| | `gradle mainBenchmark` | Execute benchmark for 'benchmarks' | |
There was a problem hiding this comment.
Should be 'main' in this example project.
There was a problem hiding this comment.
Thank you for your pointing this out and for your feedback.
There was a problem hiding this comment.
This comment doesn't seem to be resolved.
Should be something like Runs benchmarks for 'main' benchmark target.
There was a problem hiding this comment.
My apologies, I believe I resolved it and lost my changes without saving. Will address
OndrejSliva
pushed a commit
to OndrejSliva/kotlinx-benchmark
that referenced
this pull request
Jan 10, 2024
…e.maven.plugins-maven-resources-plugin-3.3.1 build(deps): bump maven-resources-plugin from 3.3.0 to 3.3.1
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses #96
This pull request introduces README files to each example subdirectory and the root examples directory. These README files serve as a guide to help both new and experienced users navigate and understand the structure and use of each example. The goal here is to improve the user experience by providing helpful and clear information about each example, making it easier for developers to get started with or dive deeper into the kotlinx-benchmark library.
Please review and let me know if there are any suggestions or improvements. Thanks!