Skip to content

[Docs] Rename Readme.md to README.md #15

@Jayrodri088

Description

@Jayrodri088

Complexity / points: Trivial (100 points) - maintainer label: points-100-trivial

PR must include:

  • Closes #15 in the PR description
  • Tests added or updated where behavior changes
  • Docs updated if public API, lifecycle, or deploy steps change
  • No unwrap() in production Soroban contract paths (project convention)
  • cargo test passes locally; match CI (cargo fmt, cargo clippy -D warnings) when touching Rust

Problem

The repo root README file is named Readme.md (capital R, lowercase rest). Many tools and conventions expect README.md specifically.

On case-sensitive environments (some CI systems, package managers, docs tooling), the README may not render or may be missed.

Proposed change

Rename Readme.md to README.md and verify that links inside still work.

Acceptance criteria

  • Readme.md renamed to README.md
  • GitHub renders the README on the repo root
  • Any internal relative links are corrected if they were case-sensitive
  • Link to docs/API.md remains correct after docs/API work is completed

Dependencies

Recommended to keep this independent, but it can be coordinated with [Docs] Add missing docs/API.md... so that all README links are valid as soon as possible.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions