Documentation

[smaranjitghose]

1. Suggested Structure for ReadMe:

• Project Name
• Project Description
• Snapshots
• Tech Stack Used
• How to Contribute
• Learning Resources
• Code of Conduct
• Project Admin and Mentors
• License

Try to put in more emojis,gif,images

Some Resources to get started with:

• Basics of GitHub Markdown https://guides.github.com/features/mastering-markdown/

• Some more tips on GitHub Markdown https://ghost.org/changelog/markdown/

• For creating badges: https://shields.io/

• Quick Fetch badges: https://github.com/Naereen/badges

• Emoji Cheatsheet: https://www.webfx.com/tools/emoji-cheat-sheet/

Samples of the ReadMes of my other projects:

• https://github.com/smaranjitghose/PyDeceive
• https://github.com/smaranjitghose/DeepPixel

2. Work on the documentation of the project:

• Don't change any of the base code
• Take one page at a time
• Put comments for what each section does, so that it is easy for anyone to change certain content
• Continue the same for other pages too
• Keep in mind that the project in the development phase so pages are ought to be changed so update the documentation accordingly
• Create Snapshots of the pages in asnapshot directory inside images so that it can be used later.

3. Guide.MD

• Create a guide.MD file where you have beautifully laid out what each section of each of the files is about and changing which parts one can use this repo for their own purpose

[sonalsk]

We, team FemmeTech, would like to work on this issue. Please assign it to me or @sakshi1499

[sakshi1499]

Assign it to me :)

[escher-m]

Is there any further requirement to improve the documentation?

[smaranjitghose]

Yes, Task 2 as I have mentioned above

[escher-m]

I would like to work on Task 2 and 3. Please assign those to either @chhavi18387 or me unless work is already underway on them.

-Team BigUhOh (RGSoC '20)