Skip to content

Updated README to show important information first#364

Merged
adriengivry merged 2 commits intomainfrom
doc/readme_tldr
Feb 14, 2025
Merged

Updated README to show important information first#364
adriengivry merged 2 commits intomainfrom
doc/readme_tldr

Conversation

@adriengivry
Copy link
Copy Markdown
Member

@adriengivry adriengivry commented Feb 13, 2025

Description

Updated README to be more catchy, and show important information first.

Also removed the "History of Overload" section because no one really cares 😄

To see what it looks like in context: https://github.com/adriengivry/Overload/blob/doc/readme_tldr/README.md

@adriengivry adriengivry added the Documentation Improvements or additions to documentation label Feb 13, 2025
@adriengivry adriengivry self-assigned this Feb 13, 2025
@adriengivry adriengivry changed the title Updated README.md Updated README to show important information first Feb 13, 2025
@adriengivry adriengivry changed the base branch from develop to main February 14, 2025 15:29
@adriengivry adriengivry merged commit dc33e5b into main Feb 14, 2025
@adriengivry adriengivry deleted the doc/readme_tldr branch February 14, 2025 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation

Development

Successfully merging this pull request may close these issues.

2 participants