Clarify README - Githubissues

DonutWare / Fladder

Fladder - A Simple Jellyfin frontend built on top of Flutter.

https://donutware.github.io/Fladder/

GNU General Public License v3.0

312 stars 14 forks source link

Clarify README #124

Closed bazzadazza72 closed 1 week ago

bazzadazza72 commented 2 weeks ago

Pull Request Description

Added AUR install instructions (thanks @tam1m)
Added license file reference and clarified license text
Fixed grammar and punctuation for Play Store instructions
Fixed grammar and added code blocks for the web build notice
Clarified releases text

Issue Being Fixed

This PR doesn't resolve an issue.

Checklist

[x] If a new package was added, did you ensure it works for all supported platforms? Is the package well maintained
[x] Check that any changes are related to the issue at hand.

Edit: Added AUR package creator's username

bazzadazza72 commented 2 weeks ago

Feel free to deny the PR if you're not a fan of my changes, I understand I may have changed most of your creation.

bazzadazza72 commented 1 week ago

Lets try to keep this part short. This list would become very long if we wrote instructions for all combinations of packge manager, distro etc.

That's fair. There's also a possibility of creating a wiki like I've said before, with installation instructions and things like that. Should we move instructions into there instead of cluttering up the readme?

bazzadazza72 commented 1 week ago

There we go, I've applied your requested changes, let me know if you're down to write a wiki.

bazzadazza72 commented 1 week ago

Alright sounds good. Is there a possibility we could get a wiki opened up in the repository?

PartyDonut commented 1 week ago

Alright sounds good. Is there a possibility we could get a wiki opened up in the repository?

For now easiest way would be to create a instructions folder and just include a markdown file in there, maybe something like linux.md or just install.md? Editing restrictions on Wiki pages is a bit iffy.

I'd like to keep every contribution inside of PR's to better track everything.

bazzadazza72 commented 1 week ago

Alright sounds good. Is there a possibility we could get a wiki opened up in the repository?

For now easiest way would be to create a instructions folder and just include a markdown file in there, maybe something like linux.md or just install.md? Editing restrictions on Wiki pages is a bit iffy.

I'd like to keep every contribution inside of PR's to better track everything.

That's totally fine, I'll slip through a PR in the next couple days.