Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update readme to final version #97

Merged
merged 2 commits into from
Jan 25, 2025
Merged

Update readme to final version #97

merged 2 commits into from
Jan 25, 2025

Conversation

chewmanji
Copy link
Member

Resolves #63

Feel free to suggest changes 🥰

@chewmanji chewmanji added the documentation Improvements or additions to documentation label Jan 24, 2025
@chewmanji chewmanji self-assigned this Jan 24, 2025
maciejkrol18
maciejkrol18 reviewed Jan 25, 2025
View reviewed changes
Copy link
Member

@maciejkrol18 maciejkrol18 left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent emoji placement: headings from About to Development have an emoji as a suffix, headings from Contributing to Contact as a prefix, and 4. Run the Project and 5. View the app have no emoji at all. I'd go with prefixing

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
mejsiejdev
mejsiejdev reviewed Jan 25, 2025
View reviewed changes
README.md Outdated Show resolved Hide resolved
mejsiejdev
mejsiejdev reviewed Jan 25, 2025
View reviewed changes
README.md Outdated Show resolved Hide resolved
mejsiejdev
mejsiejdev reviewed Jan 25, 2025
View reviewed changes
README.md Outdated Show resolved Hide resolved
@chewmanji
Copy link
Member Author

and 4. Run the Project and 5. View the app have no emoji at all. I'd go with prefixing

They don't since they're more like items of list. Headers are used only for better visuals

@chewmanji chewmanji merged commit 7b04463 into main Jan 25, 2025
1 check passed
@chewmanji chewmanji deleted the feat/63-add-readme branch January 25, 2025 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mejsiejdev mejsiejdev mejsiejdev left review comments

@muclx muclx muclx approved these changes

@maciejkrol18 maciejkrol18 maciejkrol18 approved these changes

Assignees

@chewmanji chewmanji

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add final readme.md
4 participants
@chewmanji @maciejkrol18 @mejsiejdev @muclx