Documentation

[ms2892]

I need someone to document this repository for me

[adityak714]

I would like to handle this issue, if possible.

[ms2892]

Hi @adityak714.

Thank you for picking up this task. I appreciate you making the effort of helping me in maintaining this repository. I know the code might not be easy to understand at first but feel free to ask as many questions as you'd like.

There are a few pre-requisites of what I am looking for in the documentation.

1. Being able to start a development/local postgresql instance. (refer to the Makefile [setup-database])
2. To be able to run the scripts (python -m scripts/[script_name]) (and setting of environment variables as well [DB_URL])
3. A few words describing what each script does and the folder structure.

Thank you again for helping out on this task. I would also like you to refer to the Medium posts I have for this repository as it might give you a bit of a better idea for the purpose behind this repository

Links: https://medium.com/@msadiq074/building-a-quantitative-finance-project-i-got-bored-a6a57688fa22 https://medium.com/@msadiq074/building-a-quantitative-finance-project-ii-got-bored-7e5433a1c853 https://medium.com/@msadiq074/building-a-quantitative-finance-project-iii-got-bored-c72d6d1566d8 https://medium.com/@msadiq074/building-a-quantitative-finance-project-iv-got-bored-615e7defb713

[ms2892]

Also feel free to fork this repository and create a PR back to this repository. Thanks