Offering an Installation instructions revamp

[WasteOfO2]

Is your feature request related to a problem? Please describe. It is mostly related to the fact that people new to GH in general may have some trouble locating the instruction set for the usage of these shaders.

I have seen some issues on this repo that seem to indicate to this exact problem.

Describe the solution you'd like

Since I run Linux myself, I can offer a write-up for it with a proper set of instructions

Instructions curently provided are straight-forward and self explanatory already, but I believe elaborating a bit more and providing screenshots would be more intuitive, since this is actually the only repo for shaders that actually seems to include instructions.

Describe alternatives you've considered I have only really considered moving the current "GLSL_Instructions.md" to the wiki as a part of installation instructions, since I believe they are more belonging there, if not on the README.md

[bloc97]

The wiki is pretty much outdated at this point, and I've been too busy to work on this... I've already put the installations link in the releases section though. Do you think it's not visible enough for some people? Opinions on how to improve this are welcome...

On a side note, shader installation is also covered by the mpv manual, but most people probably don't read it as it is more like a complete documentation than a manual...

[WasteOfO2]

The wiki is pretty much outdated at this point, and I've been too busy to work on this... I've already put the installations link in the releases section though. Do you think it's not visible enough for some people? Opinions on how to improve this are welcome...

On a side note, shader installation is also covered by the mpv manual, but most people probably don't read it as it is more like a complete documentation than a manual...

I do believe it is good enough to have the shaders in releases section, at most, people will clone the repo directly instead of going into the releases section. No issues there whatsoever.

Well, people generally expect a short and concise guide on the repo itself, saves them some googling.

It is more about getting your stuff done in one place, instead of reading one set of instructions, then for it to not work, then for you to google everything, realizing the fact that it was of no use, and so on. I just want to save people's time.

It shouldn't be intimidating, as people of varying skill levels in regards to computers watch anime, it would be in best interest to target the lowest common denominator.

[hooke007]

As a man who keep using mpv as the main media player, I understand that mpv is not a friendly tool for dummies. Also it is not well-known for most Windows users, which leads that there is few popular instruction of mpv on the Internet. The core issue is not they don't know how to configure Anime4k. They don't know how to use mpv at all.

On Reddit, countless of simple questions about usage of mpv exist, even though it could be easily solved by quickly searching in the mpv manual, they would repeat again and again. The community administrator also noticed it and had to add the new post to remind rookies to read the manual first rather than frequently ask some stupid questions...

Other devs who create shaders of mpv also seem to face the same issue that we have to teach users to use mpv at first (many problems are not releted with the repo).

I have no better idea on how to solve this, mpv is over-powerful but few of people are totally familiar with it. The lack of popular front-end further block the users who only like GUI. What's more, I personally think the manual is clear enough, but most people cannot read it.

[WasteOfO2]

If you ask me, you cannot always seem to blame the user for "not knowing enough beforehand".

Sure, the manual exists. Sure, it is great. Sure, MPV is quite literally amazing. People WANT to use MPV, because they realise that it is indeed wonderful and want to learn more.

As a person who has very recently transitioned from Windows and all the Google and Microsoft stuff, I have come to realise that stuff is very much spoon-fed there, as compared to what we have here. I will not argue which is inherently better for the greater good, as it is a very controversial thing to speak of.

I have knowingly jumped in on the open-source philosophy and there are things from a transitioner's perspective that veterans don't tend to generally notice, or have gotten used to certain things.

Point being, I can see why people don't want to read the manual, because it is overwhelming. I want to simplify that.

In short, the transition from using locked-down, closed-source, etc, etc to an open-source and free(free as in free beer and ability to do whatevs) is not easy for all.

Installing shaders shouldn't be hard, and it isn't. Presentation matters, which, although has been done well enough, may seem vague to some users.

I cannot really code, however, I know well enough to understand the project's aim and terminologies to explain to others, hence, I generally help out by improving documentations of the projects I see worth my time.

Obviously, what I am doing is kind of spoon-feeding, but I am okay with it. In my eyes, presentation bridges the gap between the illiterate and the literate. A very simple example could be teachers in schools, although their knowledge would be similar, their presentation defines their compatibility with their job.

[bloc97]

I can understand both sides of the problem... While catering to everyone would be the best case scenario, it unfortunately takes a lot of time. For each iteration of Anime4K I would have to update the wiki, instructions and everything, and simply I don't have the time. Training the networks, drafting and designing new architectures/datasets, cleaning up the code and updating the instructions is almost reaching the limit on what I can do with my free time. I barely had enough time recently to release an experimental GAN shader (without any instructions or explanation), and I'm now back to being fully occupied with writing my thesis...

I can't work on this full time as I get zero monetary benefits (and I like to keep some projects this way, there's less pressure and no conflicts of interests).

If you would like to contribute, feel free to discuss possible changes, and if they seem sound, you can then make the modification you want by sending a pull request.

[WasteOfO2]

I can understand both sides of the problem... While catering to everyone would be the best case scenario, it unfortunately takes a lot of time. For each iteration of Anime4K I would have to update the wiki, instructions and everything, and simply I don't have the time. Training the networks, drafting and designing new architectures/datasets, cleaning up the code and updating the instructions is almost reaching the limit on what I can do with my free time. I barely had enough time recently to release an experimental GAN shader (without any instructions or explanation), and I'm now back to being fully occupied with writing my thesis...

I can't work on this full time as I get zero monetary benefits (and I like to keep some projects this way, there's less pressure and no conflicts of interests).

If you would like to contribute, feel free to discuss possible changes, and if they seem sound, you can then make the modification you want by sending a pull request.

Yes, I understand your situation.

I do want to contribute to this project and I am willing to discuss possible changes.

I will make a PR soon to see whether or not it matches your expectations.

Not everything has to be updated with each iteration, however, basic instructions don't really change. At most, you might have to mention what exactly changed.

I do like this project a lot, and clearly others do as well. So yes, there is a good number of eager contributers, including myself.

Although, I do want to hear from you about what you believe should be changed in the wiki aside from the instructions.