search

trakBan / spongebob-cli

Watch classic spongebob from the terminal! 🎥🧽
GNU General Public License v3.0
570 stars 23 forks source link

improve readme more #17

Closed getchoo closed 2 years ago

getchoo commented 2 years ago

i fixed the formatting to be a bit more traditional with the title always being the largest element, as well as just more appealing in my opinion. i also improved some wording and removed sudo where it did not need to be used (such as with the chmod command being used with sudo even when the user will have permission to make the file the executable).

juliapaci commented 2 years ago

for the dependencies, I think that they should either be installed separate from python or include all of the dependencies from setup.py. Maybe both.

trakBan commented 2 years ago

Im going to look into this a little more, will merge in a few hours.

getchoo commented 2 years ago

for the dependencies, I think that they should either be installed separate from python or include all of the dependencies from setup.py. Maybe both.

it's easier for people just attempting to install the script to use setup.py and install the required modules that way, as not all distros can allow for modules like prettytable to be installed through the package manager (unless the developers of the module have created a third party package outside of the repos). mpv is an exception to this as most repos already have it. furthermore, if you're attempting to make a package for this, you can just tell setup.py to not install dependencies so you can just use the package manager that way

getchoo commented 2 years ago

i think the best solution this could be recommending people first install a package that's available for their distro, as then the chance of them failing the installation - or something just going on with setup.py causing it to fail - are all almost zero. This would require more people to make packages for other distributions such as debian, fedora, gentoo, etc - so it's definitely a longer term thing. setup.py should be used as a kind of last resort in case there isn't a package available (as that would always be the easiest way to get this script), and install the modules that way as it does currently (mpv can be the exception as I said before). setup.py could also be run with install --user so that sudo wouldn't be needed at all; i doubt that a script like this would be used my multiple users and thus shouldn't be placed in /usr/bin to do so. I've tested this on my own machine, and it works perfectly with spongebob-cli installing to $HOME/.local/bin and the libraries also installing to $HOME/.local/lib. Installing as a user would also prevent any conflicts with packages from their package manager (again, another reason not to install spongebob-cli and libraries from setup.py in /usr).

so i guess what i'm trying to say is - these would be the most optimal instructions in my opinion:

cd spongebob-cli
chmod +x spongebob-cli
python setup.py install --user
trakBan commented 2 years ago

Thanks for contributing to spongebob-cli. Approved!