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.

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

Make readme more user friendly #117

Merged
merged 9 commits into from
Oct 17, 2022
Merged

Make readme more user friendly #117

merged 9 commits into from
Oct 17, 2022

Conversation

geek-yang
Copy link
Member

Polish and decorate readme by adding some graphs and figures.

This PR closes #29.

@geek-yang geek-yang marked this pull request as ready for review October 12, 2022 13:56
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

@SarahAlidoost SarahAlidoost left a comment

Choose a reason for hiding this comment

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

@geek-yang thanks, look much better. We can further polish it when we switch to the python-compliant branch.
Just some minor fixes, see my comments.

@geek-yang
Copy link
Member Author

@geek-yang thanks, look much better. We can further polish it when we switch to the python-compliant branch. Just some minor fixes, see my comments.

Thanks for your review @SarahAlidoost . I have addressed your comments and it is ready for your review again. 😉

Copy link
Member

@SarahAlidoost SarahAlidoost left a comment

Choose a reason for hiding this comment

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

@geek-yang thanks 👍

@SarahAlidoost SarahAlidoost merged commit c2db588 into main Oct 17, 2022
@SarahAlidoost SarahAlidoost deleted the polish_readme branch October 17, 2022 11:35
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.

Make readme more user friendly
2 participants