Skip to content

docs: Improve README formatting, styling and grammar#36

Open
b-l-u-e wants to merge 1 commit intobtrust-builders:mainfrom
b-l-u-e:docs/improve-readme-formatting
Open

docs: Improve README formatting, styling and grammar#36
b-l-u-e wants to merge 1 commit intobtrust-builders:mainfrom
b-l-u-e:docs/improve-readme-formatting

Conversation

@b-l-u-e
Copy link
Contributor

@b-l-u-e b-l-u-e commented May 17, 2025

This PR improves the README.md file by enhancing its formatting, styling, and grammar to make it more professional and easier to read.

Changes

  • Fixed grammatical errors throughout the document
  • Standardized header capitalization and formatting
  • Improved spacing and layout consistency
  • Enhanced clarity of instructions for new contributors
  • Corrected punctuation and sentence structure issues
  • Added an "Overview" section for better organization

Motivation

A well-formatted README is essential for making a good first impression on new contributors. These changes make the document more professional and easier to follow, which should help new contributors have a better experience with their first open source contribution.

Testing

Verified the markdown renders correctly in preview mode.

Enhance the readability of the README by fixing grammatical errors,
improving formatting consistency, and refining the overall style.
Changes include standardized headers, better spacing, and clearer
instructions for contributors.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant