7903859: add more details to the top-level README.md file

[jonathan-gibbons]

Please review a docs update, mostly correcting or adding details to the top-level README.md, but also taking this opportunity to add some details into the "man" page.

---

Progress

• Change must be properly reviewed (1 review required, with at least 1 Reviewer)
• Change must not contain extraneous whitespace
• Commit message must refer to an issue

Issue

• CODETOOLS-7903859: add more details to the top-level README.md file (Enhancement - P3)

Reviewers

• Iris Clark (@irisclark - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/apidiff.git pull/24/head:pull/24
$ git checkout pull/24

Update a local copy of the PR:
$ git checkout pull/24
$ git pull https://git.openjdk.org/apidiff.git pull/24/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 24

View PR using the GUI difftool:
$ git pr show -t 24

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/apidiff/pull/24.diff

Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back jjg! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[openjdk]

@jonathan-gibbons This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

7903859: add more details to the top-level README.md file

Reviewed-by: iris

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

[mlbridge]

Webrevs

• 00: Full (0034a5ac)

[jonathan-gibbons]

/integrate

[jonathan-gibbons]

/integrate

[openjdk]

Going to push as commit 83e4d30.

[openjdk]

@jonathan-gibbons Pushed as commit 83e4d30.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

[openjdk]

@jonathan-gibbons The command integrate can only be used in open pull requests.