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

[sakshi1499]

Please assign it to us @smaranjitghose (@sonalsk)

[smaranjitghose]

Please ask her to comment so that I can assign it to her

[chhavi18387]

@smaranjitghose Can I work on this issue ?

[smaranjitghose]

Sure!

[smaranjitghose]

This will be continued with the new UI