killergerbah / asbplayer

Browser-based media player and Chrome extension for subtitle sentence mining
MIT License
504 stars 65 forks source link

Readme: update dictionaries and regex sections #477

Closed artjomsR closed 1 month ago

artjomsR commented 2 months ago

A couple of small things that I spotted. Please feel free to amend / delete sections that you think aren't relevant.

I've also thought about git-adding the binary file for the go proxy in the repo. This would replace the 1st two steps in the One-click mining flow section (we can leave the original instructions below if someone still wants to compile it themselves). But the disadvantage is that these should be regenerated if the script contents changes, and it's difficult to provide these for all 3 OSes (not sure if you'd want PRs for these as it's kinda a security risk?). Still, if you have a Mac and you include the Mac binary, then you save Mac users a bit of hassle :)

killergerbah commented 2 months ago

I've also thought about git-adding the binary file for the go proxy in the repo.

This is a nice idea. Users would not have to download Go.

But the disadvantage is that these should be regenerated if the script contents changes, and it's difficult to provide these for all 3 OSes (not sure if you'd want PRs for these as it's kinda a security risk?).

If we can automate the building of all binaries using a script tracked in this repo I think that alleviates some security risk. I would go farther to say that the binaries should not be checked in until we've found a way to automate the build process. I am guessing it is possible using GitHub Actions to provide all the build environments.

killergerbah commented 2 months ago

Thanks for your changes. I have a final nitpick: "e.g." should be used when listing examples of things, not "i.e.

artjomsR commented 1 month ago

I've also thought so but originally decided to stick to i.e. for consistency :) Updated them now. Also probably a good idea to squash all these commits when you merge this PR

killergerbah commented 1 month ago

Okay awesome. Thanks again for all your contributions.