📝[Docs]: README.md page for OpenCV Projects/ParkingSpaceDetector

[ananas304]

Is there an existing issue for this?

• I have searched the existing issues

Issue Description

The ParkingSpaceDetector project in the OpenCV Projects folder lacks a README file. Including a README will improve the documentation by providing users with important project information, setup instructions, and requirements.

• I would like to see an improvement in the documentation by adding a README file for the ParkingSpaceDetector project.
• This README should include a clear explanation of the project, installation steps, usage instructions, and project requirements.

Suggested Change

I propose adding a README.md file with the following sections:

1. Project Overview – A brief introduction to the ParkingSpaceDetector project and its purpose.
2. Usage – Instructions on how to run the project, including any sample input/output details.
3. Contributing – Guidelines on how others can contribute to the project.
4. Requirements – A list of the required software, libraries, and tools needed to run the project (e.g., Python version, OpenCV, etc.).

This change will help users understand the project better and contribute more easily.

Rationale

This documentation update is necessary to provide clarity and guidance to users and contributors. A README file serves as an introduction to the project, outlining its purpose, requirements, installation steps, and usage. Without this documentation, users may struggle to understand the project or set it up correctly, limiting the project's accessibility and contribution potential. Adding a README will make the ParkingSpaceDetector project more user-friendly and encourage collaboration.

Urgency

Medium

Record

• I have read the Contributing Guidelines
• I'm a GSSOC'24 contributor
• I want to work on this issue

[github-actions]

Thank you for creating this issue! 🎉 We'll look into it as soon as possible. In the meantime, please make sure to provide all the necessary details and context. If you have any questions reach out to LinkedIn. Your contributions are highly appreciated! 😊

Note: I Maintain the repo issue twice a day, or ideally 1 day, If your issue goes stale for more than one day you can tag and comment on this same issue.

You can also check our CONTRIBUTING.md for guidelines on contributing to this project.
We are here to help you on this journey of opensource, any help feel free to tag me or book an appointment.

[ananas304]

Please consider labeling this issue with the gssoc and hacktoberfest tags, as I would like this contribution to be counted toward both programs.

[ananas304]

Request to Change Issue(#1433) Level: [Docs]: README.md page for OpenCV Projects/ParkingSpaceDetector from Level-1 to Level-2

Description:

I initially raised the issue "[Docs]: README.md page for OpenCV Projects/ParkingSpaceDetector" flagged as level-1. However, I’ve identified that the README task also required:

1. A missing requirements.txt file to specify dependencies.
2. A Python file for marking parking spaces, which I wrote (see code snippet below).

import cv2
import pickle

posList = []
cap = cv2.VideoCapture('carPark.mp4')
success, img = cap.read()

def mouseClick(events, x, y, flags, params):
    if events == cv2.EVENT_LBUTTONDOWN:
        posList.append((x, y))
    if events == cv2.EVENT_RBUTTONDOWN:
        for i, pos in enumerate(posList):
            if pos[0] < x < pos[0] + 107 and pos[1] < y < pos[1] + 48:
                posList.pop(i)

    with open('CarParkPos', 'wb') as f:
        pickle.dump(posList, f)

while True:
    for pos in posList:
        cv2.rectangle(img, pos, (pos[0] + 107, pos[1] + 48), (0, 255, 0), 2)
    
    cv2.imshow("Image", img)
    cv2.setMouseCallback("Image", mouseClick)
    
    if cv2.waitKey(1) & 0xFF == ord('q'):
        break

cap.release()
cv2.destroyAllWindows()

3. An MP4 video (carPark.mp4) needed for the code to work correctly.

Since it involves multiple aspects (code, files, and documentation), I believe it exceeds the scope of a simple README issue. I kindly request @sanjay-kv to consider upgrading the issue to Level-2 for better alignment with the work involved.

[sanjay-kv]

could you send me the PR

[ananas304]

done.

[github-actions]

Hello @ananas304! Your issue #1433 has been closed. Thank you for your contribution!