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

Revamp README #442

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Revamp README #442

wants to merge 3 commits into from

Commits on Dec 2, 2023

  1. readme: fix typo 

    `-` in the `files` clause matches a file named `-`. This is probably a mistake.
    @sorawee
    sorawee committed Dec 2, 2023
    Configuration menu
    Copy the full SHA
    5b1bd06 View commit details
    Browse the repository at this point in the history

  2. readme: use appropriate heading levels 

    Use h1 for the title, h2 for sections, h3 for subsections, etc.
    @sorawee
    sorawee committed Dec 2, 2023
    Configuration menu
    Copy the full SHA
    af8547a View commit details
    Browse the repository at this point in the history

  3. readme: revamp introduction 

    - Fix dead links
- Improve organization
- Update the `using` clause's version
- Add a compatability section. One TODO remains.
- Make the example more interesting
  (by introducing an unintentional compilation error)
    @sorawee
    sorawee committed Dec 2, 2023
    Configuration menu
    Copy the full SHA
    c0b63bf View commit details
    Browse the repository at this point in the history