Bookingjini-Tech / bookingjini-icons-archive

Find hospitality related icons, curated by creators from Bookingjini
https://icons.bookingjini.tech
MIT License
44 stars 116 forks source link

[DOCS] Update Readme #474

Closed Parul1606 closed 1 year ago

Parul1606 commented 1 year ago

Description

Current State: The Contributing section of the README file requires extra documentation. Some commands that should be applied while contributing to the project are missing.

Desired State: I know some small basic steps don't require to be explained. But, I would like to add those extra commands like a repository should be pulled by creating a remote repository(for reference), the first step like creating a folder at your desired location, etc. I have divided the whole process into 17-18 simple steps which will be easy to understand by the contributors. I won't be deleting any part will just modify it in a better way. I have the desired image of how it will look after updating the README. The image attached is just an outlook of how README will be displayed:

Screenshots

image

Additional information

No response

Checklist

Parul1606 commented 1 year ago

Please assign me this issue, I would like to work on it under gssoc @AshutoshDash1999

AshutoshDash1999 commented 1 year ago

These are already added in the readme. Nothing more to add for now.

I have divided the whole process into 17-18 simple steps

don't you think 17-18 steps will be too long to follow?

Parul1606 commented 1 year ago

These are already added in the readme. Nothing more to add for now.

I have divided the whole process into 17-18 simple steps

don't you think 17-18 steps will be too long to follow?

But 2 commands are necessary to follow add remote reference to project, and fetching upstream main @AshutoshDash1999