Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improvements to README #552

Merged
merged 8 commits into from
Sep 8, 2022
Merged

Improvements to README #552

merged 8 commits into from
Sep 8, 2022

Commits on Aug 25, 2022

  1. Wrap lines to 90 characters

    @nre-ableton
    nre-ableton committed Aug 25, 2022
    Configuration menu
    Copy the full SHA
    4ba65ca View commit details
    Browse the repository at this point in the history

  2. Have one newline between sections/paragraphs

    @nre-ableton
    nre-ableton committed Aug 25, 2022
    Configuration menu
    Copy the full SHA
    c04fe7a View commit details
    Browse the repository at this point in the history

  3. Add documentation on Java requirements

    @nre-ableton
    nre-ableton committed Aug 25, 2022
    Configuration menu
    Copy the full SHA
    f3fe2f7 View commit details
    Browse the repository at this point in the history

  4. Improve section titles 

    - Use title case
- Use present progressive tense
- Improve wording in some places
    @nre-ableton
    nre-ableton committed Aug 25, 2022
    Configuration menu
    Copy the full SHA
    6af7f2a View commit details
    Browse the repository at this point in the history

  5. Make separate sections for Maven/Groovy 

    Also de-indent code examples.
    @nre-ableton
    nre-ableton committed Aug 25, 2022
    Configuration menu
    Copy the full SHA
    7322ac6 View commit details
    Browse the repository at this point in the history

  6. Improve example code 

    - Use proper types
- Update to JUnit 5
- Fix indentation/whitespace
- Make CodeNarc-friendly
    @nre-ableton
    nre-ableton committed Aug 25, 2022
    Configuration menu
    Copy the full SHA
    8d9f252 View commit details
    Browse the repository at this point in the history

  7. Improve wording/grammar

    @nre-ableton
    nre-ableton committed Aug 25, 2022
    Configuration menu
    Copy the full SHA
    f3d9f43 View commit details
    Browse the repository at this point in the history

  8. Remove tree directory listings 

    This is covered in the Jenkins shared pipeline documentation.
    @nre-ableton
    nre-ableton committed Aug 25, 2022
    Configuration menu
    Copy the full SHA
    6a17da4 View commit details
    Browse the repository at this point in the history