Skip to content
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

Add installation, contributing instructions to readme #570

Closed
wants to merge 4 commits into from

Conversation

wigiwee
Copy link

@wigiwee wigiwee commented Dec 27, 2024

Important
This pull request addresses an issue with the README.md file of the YoutubeDownload repository, which lacked installation instructions. This omission led to confusion and wasted time for users trying to install and use the application. It took me 20 min to get this running locally

Summary of Changes:

  • Added clear and detailed installation instructions to the README.md file.
  • Included steps for setting up and running the application.
  • Ensured that the new instructions align with the project's existing format and style.

Why This Change Is Necessary:
The absence of installation instructions in the README.md made it challenging for users to get started with the project. By providing a well-documented guide, this update aims to improve the user experience and reduce onboarding time for new users.

@Tyrrrz
Copy link
Owner

Tyrrrz commented Dec 30, 2024

This omission led to confusion and wasted time for users trying to install and use the application. It took me 20 min to get this running locally

Did you struggle with specifically building it locally or running the downloaded version locally?

If the former, it's better to put these instructiosn into a Contributing.md file.

@Tyrrrz Tyrrrz added the enhancement New feature or request label Dec 30, 2024
@Tyrrrz Tyrrrz changed the title adding installation, contributing instructions in Readme.md file Add installation, contributing instructions to readme Dec 30, 2024
@Tyrrrz Tyrrrz requested a review from Copilot December 30, 2024 10:44
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.

Readme.md Show resolved Hide resolved
Readme.md Outdated Show resolved Hide resolved
Readme.md Outdated Show resolved Hide resolved
Co-authored-by: Copilot <[email protected]>
@wigiwee
Copy link
Author

wigiwee commented Dec 30, 2024

Did you struggle with specifically building it locally or running the downloaded version locally?

running downloaded version locally

@wigiwee wigiwee closed this by deleting the head repository Jan 2, 2025
@Tyrrrz Tyrrrz added invalid This doesn't seem right and removed enhancement New feature or request labels Jan 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
invalid This doesn't seem right
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants