[Feat]: Improve Documentation with READMEs for Individual Scripts

[juj-star]

Is your feature request related to a problem? Please describe.

There are several scripts in the repository that lack a dedicated README, making it harder for new users to understand their purpose and usage. Without these detailed READMEs, it can be challenging for both users and potential contributors to grasp the full functionality and potential of these scripts. For instance, I've noticed that the AI Calculator, along with two other scripts, don't have individualized documentation.

Describe the solution you'd like.

I propose creating dedicated READMEs for the following three scripts as a starting point:

AI Calculator
Air pollution Prediction
Automated scraper

These READMEs should provide:

A brief description of the script.
Pre-requisites or dependencies.
Step-by-step usage instructions.
Sample input/output or demonstrations.
Any other relevant information that a new user or contributor might need.

By creating these READMEs, we set a standard and precedent for other scripts in the repository, potentially encouraging other contributors to do the same for the remaining scripts.

Describe alternatives you've considered.

Inline Comments: While adding detailed inline comments within the script can provide some clarity, it doesn't offer the structured and comprehensive guide that a README can provide.

Centralized Documentation: Another approach could be to have a single, centralized documentation that covers all scripts. However, this could become overwhelming and might not be as user-friendly as individual READMEs.

Show us the magic with screenshots

Record

• I agree to follow this project's Code of Conduct
• I'm a GSSoC'23 contributor
• I want to work on this issue

[github-actions]

To reduce notifications, issues are locked. Your issue will be unlocked when we add the label gssoc23. If you're participating in GSSoC'23, please add the gssoc23 label to your issue.