Giter Site home page Giter Site logo

Comments (5)

LazaroOnline avatar LazaroOnline commented on May 29, 2024

No comments in source code is a good thing.
Maybe what you mean is you would like to find more documentation, for example in markdown files, or that the code would be cleaner so that it is easier to read.

from youtubedownloader.

LazaroOnline avatar LazaroOnline commented on May 29, 2024

By the way, I cloned this repo (and the git submodule), executed it, and got the error message: "Failed to connect to Aria2", but I don't see any documentation on how to get the repo working.
It would be nice to have a doc or script that initializes all that this repo requires so I can run it without manual steps.

from youtubedownloader.

LazaroOnline avatar LazaroOnline commented on May 29, 2024

I found the solution to make the app work, it would be nice to add this to the docs:

## Project Setup
Next to the "`YoutubeApp.exe`" main app, create a folder named "utils" and get these 3 files from the internet:
- "aria2c.exe" from https://github.com/aria2/aria2/releases (look for the releases file download `aria2-1.37.0-win-64bit-build1.zip`).
- "yt-dlp.exe" from https://github.com/yt-dlp/yt-dlp/releases (look for the `yt-dlp.exe` file)
- "ffmpeg.exe" from https://github.com/BtbN/FFmpeg-Builds/releases (for example the `ffmpeg-master-latest-win64-gpl.zip` and extract the `ffmpeg.exe`)

from youtubedownloader.

Neurofibromin avatar Neurofibromin commented on May 29, 2024

No comments in source code is a good thing. Maybe what you mean is you would like to find more documentation, for example in markdown files, or that the code would be cleaner so that it is easier to read.

Hard disagree. Good comments help understanding and make code more readable. Although I admit, this is a highly debated topic in the community, it would seem that most major projects also use comments.
https://stackoverflow.blog/2021/12/23/best-practices-for-writing-code-comments/

Also bringing up a totally different problem in this issue is inappropriate, please open a new issue for those instead of discussing them here.

from youtubedownloader.

LazaroOnline avatar LazaroOnline commented on May 29, 2024

This issue is too generic and open ended, what amount of comments, where, about what in particular are you expecting?
I didn't mean to bring another subject, instead I materialized it into a real scenario that is understanding how to setup the project for local execution and gave a solution to it in a PR.
You can keep adding more specific subjects you would like to find more comments/docs about.

About comments, for sure "good" comments are great specially when they explain the questions "why" the code is that way, but sometimes there is just nothing worth commenting down, I don't know if it is the case for this repo or not, but the issue sounds like saying "No comments >> therefore the code is hard to read", which is not necessarily true.

from youtubedownloader.

Related Issues (14)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.