Readme contribution

[joanita-51]

Added Table of Contents and README Sections

This pull request enhances the README by adding a table of contents for easier navigation and adding several sections to provide a more comprehensive project overview. Here's a summary of the changes as suggested in issue #63

Table of Contents: Added a table of contents for quick access to different sections of the README.

Project Overview: For a more detailed description of the project.

Project Benefits: To highlight the benefits of this project.

Images for Other Shapes: Added images to showcase the various shapes available apart from the one mentioned during installation.

Contribution: Contains detailed instructions for potential contributors.

This PR aims to make the README more informative and user-friendly.

[joanita-51]

Hey @TitilayoAdeyemi and @Sudha247, here's my vision for the README on the 'ocaml-joy' project: README

Please review and let me know if there's anything I've missed or should remove.

[TitilayoAdeyemi]

@joanita-51 I think you did a great job, this is really awesome. Weldone!

What I think though, is that instead of us to put so many beautiful pictures like you did, we should just put like 6 or 7. A simple one like the circle first, then some more complex ones and the last one should be yet more complex and each of these should have a very short summary under them....It could be just a line describing what the particular shape is/can be used for. I think we should do this so that when prospective users or contributors take a look at the readme file, they'd be intrigued and want to check out the entire project, kind of like a bait instead of laying out all our pictures. And I think this should be under a subheading with a title like "Shape examples" rather than "Other wonderful shapes" as a continuation of the circle example.

This is what I think. Once again, weldone Joanita! :)

[joanita-51]

@joanita-51 I think you did a great job, this is really awesome. Weldone!

What I think though, is that instead of us to put so many beautiful pictures like you did, we should just put like 6 or 7. A simple one like the circle first, then some more complex ones and the last one should be yet more complex and each of these should have a very short summary under them....It could be just a line describing what the particular shape is/can be used for. I think we should do this so that when prospective users or contributors take a look at the readme file, they'd be intrigued and want to check out the entire project, kind of like a bait instead of laying out all our pictures. And I think this should be under a subheading with a title like "Shape examples" rather than "Other wonderful shapes" as a continuation of the circle example.

This is what I think. Once again, weldone Joanita! :)

I agree with that, thanks @TitilayoAdeyemi!

[nangahamandine]

Hey @TitilayoAdeyemi and @Sudha247, here's my vision for the README on the 'ocaml-joy' project: README

Please review and let me know if there's anything I've missed or should remove.

Wow beautifully done @joanita-51!!! You did an amazing job 👍
Kudos! 💯

[joanita-51]

Hey @TitilayoAdeyemi and @Sudha247, here's my vision for the README on the 'ocaml-joy' project: README
Please review and let me know if there's anything I've missed or should remove.

Wow beautifully done @joanita-51!!! You did an amazing job 👍 Kudos! 💯

Thank you @nangahamandine

[Sudha247]

Thank you @joanita-51! This is a great start. I've suggested some changes below.

[Sudha247]

This is quite useful, especially considering this library is aimed to be easy to use for non-OCaml programmers. However, I'd prefer the Installation instructions and the contribution section moved to a separate file, HACKING.md or CONTRIBUTING.md. The new file can be referenced in the README.

[joanita-51]

Thank you, @Sudha247! I'll start working on the changes right away.

[joanita-51]

Thanks, @Sudha247! I have moved the installation and contribution section to CONTRIBUTING.md, referenced in README