Add documentation

[akshitadixit]

The current code contains minimalistic documentation that too at only some places. Objective of this issue will be:

• [x] Improve readme instructions
• [ ] Add comments in code
• [ ] Add docstrings for functions that might need elaborate commenting

You are free to pick up any or all of the above 3 sub-tasks. For any assistance, feel free to reply to this.

[jayant766]

Please assign me this issue under LGMSOC'21

[akshitadixit]

Sure @jayant766 :)

[KishkinJ10]

can I also work on this? I am LGM-SOC 21 participant

[akshitadixit]

@jayant766 please let us know your progress, we have somebody who would like to share your work :)

And @KishkinJ10 let's wait till EOD until Jayant replies just to give him a fair chance, after which I'll assign the issue to you.

[jayant766]

@akshitadixit I am working on it. Please don't assign it to anyone till tomorrow evening. If anyone wants to collaborate with me I am ready.

[akshitadixit]

@jayant766 sure

Meanwhile @KishkinJ10 you can connect with Jayant over slack to collaborate and make PRs for different files if you wish.

[Itashamodi]

assign me

[akshitadixit]

@Itashamodi sure

[Sidhved]

Can this one be assigned to me under LGMSOC'21? I'll like to collaborate with other participants and help with documentation process

[akshitadixit]

@Sidhved sure reach out to them on slack