Skip to content

Readme Improvments#2

Open
mehdie79 wants to merge 2 commits into
gaganis:mainfrom
mehdie79:main
Open

Readme Improvments#2
mehdie79 wants to merge 2 commits into
gaganis:mainfrom
mehdie79:main

Conversation

@mehdie79

Copy link
Copy Markdown
Contributor

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!

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.

1 participant