upes-open / OSoC-DoorDarshan

3 stars 2 forks source link

improve the readme.md #16

Closed karthiknadar1204 closed 10 months ago

karthiknadar1204 commented 1 year ago

Here i propose to make the readme elaborate by adding an elaborate way to open a pr and set up the project as well as shell commands so that anyone starting out with the project can start out easily

karthiknadar1204 commented 1 year ago

I would like to work on this issue under osoc'23

saarinii commented 1 year ago

Hey Karthik ! Updating the README.md is not a feature solving in the project. The readme is already designed by our heads, also the documentation will be done at the last of the OSoC'23. Updating the README.md will contain the UI screenshots, brief features of project.

karthiknadar1204 commented 1 year ago

So what will i be adding to the readme for now could you please elaborate, also please reconfirm if this issue for documentation will be considered for points @saarinii

saarinii commented 1 year ago

You can add UI screenshots, brief features of the project, etc but do not change the format of it. Yes it will be counted a issue of easy category

karthiknadar1204 commented 1 year ago

But the project doesn't seem to have been initialized yet

saarinii commented 1 year ago

Then you'd have to wait till it does