Skip to content

Readme.md vs README.md casing #3

@DevanshSrajput

Description

@DevanshSrajput

Context
The file is named Readme.md (capital R, lowercase rest). GitHub
redirects both casings to one canonical URL, but other tools don't
— for example, the Streamlit Cloud image is case-sensitive and
will 404 a link that says readme.md. The GitHub norm and the
norm most Linux tooling expects is README.md.

What to change

  1. git mv Readme.md README.md (this preserves file history).
  2. Run grep -rIn 'Readme.md' . and update every internal link
    (especially in the tree blocks and the "What Is This" pointer).
  3. Confirm the file still renders on GitHub: the repo's homepage
    should show the README content as before, with no broken-image
    or 404 banner.

How to verify

  • ls README.md succeeds; ls Readme.md fails.
  • grep -rIn 'Readme.md' . returns nothing (case-sensitive).
  • git log --follow README.md shows the full history of the
    renamed file.

Skill: trivial, but tests you on git mv semantics.
Estimated effort: S.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions