RFR: CODETOOLS-7903567: JMH: Improve README guidance for archetype bootstrap

[abyrne133]

On Mon, 2 Oct 2023 14:32:02 GMT, Aleksey Shipilev <shade at openjdk.org> wrote:

>> Attempting to execute the "mvn archetype:generate" command specified in Step 1 of Preferred Usage in the README will result in a maven execution error if you interpret it like I did! In my case I naively interpreted the following text to mean that I could create a sub project within the test folder of my already existing java project. "test" is the default test folder!
>> 
>> _
>> 
>>> "Step 1. Setting up the benchmarking project. The following command will generate the new JMH-driven project in test folder:"
>> 
>> _
>> 
>> This resulted in 10-15 minutes of trying to figure out if I needed to install something new to use mvn archetype - as I have not used it before.
>> 
>> This change might make it easier for users to get set up with JMH project templates.
>
> README.md line 28:
> 
>> 26: ### Preferred Usage: Command Line
>> 27: 
>> 28: **Step 1. Setting up the benchmarking project.** The following command will generate the new JMH-driven project in new test folder. Note that current and target folder should not already contain any Maven project for this to work reliably.
> 
> Ah wait, a little nit: `test` used to be markdown-ed.

My bad, good spot. Sorted.

> README.md line 29:
> 
>> 27: 
>> 28: **Step 1. Setting up the benchmarking project.** The following command will generate the new JMH-driven
>> 29: project in `test` folder (do not try to run the command within an already existing maven project):
> 
> Would this be more understandable?
> 
> "The following command will generate the new JMH-driven project in new `test` folder. Note that current and target folder should not already contain any Maven project for this to work reliably."

That's even better, I've committed that change. Please shout if anything else is required, thanks!

-------------

PR Review Comment: https://git.openjdk.org/jmh/pull/123#discussion_r1342824220
PR Review Comment: https://git.openjdk.org/jmh/pull/123#discussion_r1342675187