sonic-pi-net / sonic-pi

Code. Music. Live.
https://sonic-pi.net
Other
10.85k stars 923 forks source link

[docs - sonic pi] making small enhancements to readme.md #3411

Closed ghost closed 3 months ago

ghost commented 3 months ago

Certainly! Here are some common types of basic orthography and grammar updates for a README.md file, using Sonic Pi as an example:

Common Orthography and Grammar Updates

  1. Spelling Errors:

    • Correct any typos or misspellings. For example, changing "instalation" to "installation."
  2. Grammar and Punctuation:

    • Ensure sentences are complete and properly punctuated. For example, "You can install Sonic Pi on Windows, Mac, or Linux. You must follow the instructions for your operating system."
    • Correct any run-on sentences or comma splices. For example, "Sonic Pi is great for live coding music, and it is user-friendly" might be better as "Sonic Pi is great for live coding music. It is also user-friendly."
  3. Consistency in Terminology:

    • Use consistent terminology throughout the document. For example, if you refer to "commands" in one section, don’t switch to "instructions" in another without clear reason.
  4. Capitalization:

    • Ensure proper nouns and the beginnings of sentences are capitalized. For example, "sonic pi" should be "Sonic Pi" throughout the document.
  5. Verb Tenses:

    • Ensure that verb tenses are consistent and appropriate. For example, if you’re describing the current features, use the present tense: "Sonic Pi allows you to create music in real-time."
  6. Clarity and Conciseness:

    • Make sure that sentences are clear and concise. For example, instead of "It is very easy to use Sonic Pi, and it has many features that you will find useful," you could say "Sonic Pi is user-friendly and feature-rich."
  7. Subject-Verb Agreement:

    • Ensure that subjects and verbs agree in number. For example, "The features of Sonic Pi is impressive" should be "The features of Sonic Pi are impressive."
  8. Formatting and Lists:

    • Use consistent formatting for lists and headers. For example:
      ## Features
      - Real-time music creation
      - Live coding environment
      - Extensive documentation

Example Corrections

Before:

Sonic Pi is a live coding music synthesizer. you can install it on Windows, Mac, or linux. Its simple to use and very powerfull. For more infomation, visit our website.

After:

Sonic Pi is a live coding music synthesizer. You can install it on Windows, Mac, or Linux. It is simple to use and very powerful. For more information, visit our website.

Making these basic orthography and grammar updates will enhance the readability and professionalism of the README.md file, making it easier for users to understand and follow the instructions.