Skip to content

docs: refine and expand readme content#9

Merged
LiamWJH merged 1 commit into
stroll-script:mainfrom
kpeale:update-readme
Nov 15, 2025
Merged

docs: refine and expand readme content#9
LiamWJH merged 1 commit into
stroll-script:mainfrom
kpeale:update-readme

Conversation

@kpeale

@kpeale kpeale commented Nov 14, 2025

Copy link
Copy Markdown
Contributor

Overview

This pull request updates the project’s README to make it clearer, more structured, and more helpful for new users and contributors. The goal is to improve overall accessibility, readability, and professionalism while keeping the original spirit of the project.

Changes Included

  • Rewrote the introduction for clarity and purpose
  • Organized the features section into clean categories
  • Added quick usage examples
  • Improved wording, grammar, and consistency throughout the file
  • Enhanced readability with clearer markdown formatting

🎯 Why This Matters

A language/interpreter project is much easier to understand and contribute to when the documentation is clear. These changes help new users:

  • Understand what Stroll is
  • Try out features with examples
  • Contribute with confidence

🤝 Additional Notes

If you'd like further enhancements—such as adding badges, screenshots, or a roadmap—I’m happy to contribute more.

@LiamWJH
LiamWJH merged commit 551a12d into stroll-script:main Nov 15, 2025
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.

2 participants