Skip to content

Created readme examples #2986

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 15, 2023

Conversation

juj-star
Copy link
Contributor

Description

This PR focuses on adding detailed READMEs for three scripts, the AI Calculator, Automated scraper, and Air Pollution Prediction. A dedicated README provides clarity on the purpose, usage, prerequisites, and any other relevant details for each script. This can help new users and potential contributors to better understand and engage with the project.

Fixes #(issue_no)

2985

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Documentation Update

Checklist:

  • My code follows the style guidelines(Clean Code) of this project
  • [x ] I have performed a self-review of my own code
  • [x ] I have commented my code, particularly in hard-to-understand areas
  • [x ] I have created a helpful and easy to understand README.md
  • [x ] My documentation follows Template for README.md
  • [ x] I have added the project meta data in the PR template.
  • [x ] I have created the requirements.txt file if needed.

Project Metadata

`` If there is no-file/nothing to fill the below fields with, then type: none none

Example: If no requirements.txt needed/present, then type none in Requirments.

Category:

  • [x ] Calculators
  • AI/ML
  • [x ] Scrappers
  • Social_Media
  • PDF
  • Image_Processing
  • Video_Processing
  • Games
  • Networking
  • OS_Utilities
  • Automation
  • Cryptography
  • Computer_Vision
  • Fun
  • [ x] Others

Title: <AI Calculator>

Folder: <AI Calculator>

Requirements: <None>

Script: <Enter the name of the main.py file (The main entry point of the program)>

Arguments: <None>

Contributor: <juj-star>

Description: <This PR adds a README for the AI Calculator and 2 others. The README provides a brief overview, usage steps, and other essential details to help users engage with the script.>

@avinashkranjan avinashkranjan added level3 New features, Major bug fixing gssoc23 Issues created for/by the GirlScript Summer of Code'23 Participants Approved PR Approved and Ready to Merge and removed gssoc23 Issues created for/by the GirlScript Summer of Code'23 Participants labels Aug 15, 2023
@avinashkranjan avinashkranjan merged commit a2427eb into avinashkranjan:master Aug 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved PR Approved and Ready to Merge level3 New features, Major bug fixing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants