Skip to content

A better README #1003

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.

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

Merged
merged 11 commits into from
May 6, 2022
Merged

A better README #1003

merged 11 commits into from
May 6, 2022

Conversation

raklaptudirm
Copy link
Member

The current README.md is a bit all over the place, which is bad since it is the main document that visitors to the repository sees. This pull request seeks to fix that.

@raklaptudirm raklaptudirm added the code quality Code quality improvement label May 6, 2022
@raklaptudirm raklaptudirm requested a review from appgurueu as a code owner May 6, 2022 06:11
@raklaptudirm
Copy link
Member Author

@appgurueu imo we should remove the repository wiki, and instead switch to the website explanations.

@raklaptudirm raklaptudirm marked this pull request as draft May 6, 2022 07:35
@raklaptudirm raklaptudirm marked this pull request as ready for review May 6, 2022 07:40
appgurueu
appgurueu previously approved these changes May 6, 2022
Copy link
Collaborator

@appgurueu appgurueu left a comment

Choose a reason for hiding this comment

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

Otherwise it's looking good. LGTM.

@raklaptudirm raklaptudirm merged commit edd7076 into master May 6, 2022
@raklaptudirm raklaptudirm deleted the readme branch May 6, 2022 08:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code quality Code quality improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants