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

Readme Improvments #2

Open

mehdie79 wants to merge 2 commits into gaganis:main from mehdie79:main

Contributor

mehdie79 commented Jul 23, 2022

I have done the following to improve the readability and design of the readme:

Added a project logo (I hope you like it !)
Added a short description below the logo for introducing the project to the user
Added a table of content to make the navigation between sections easier
Reorganized the sections by putting the "Motivation" section after the project intro. I think this will help by improving the structure of README.
Added a License section for following the best practices.

Hope these changes help!

mehdie and others added 2 commits

July 22, 2022 21:13


          Add logo, table of content, and license section into the readme.

c29d488


          readjust the image size

f592efd

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet