AxolotlClient-mod
AxolotlClient-mod copied to clipboard
AxolotlClient
Improving README Documentation
Using what was provided on the github page as well as your other pages such as modrinth, I have formatted the README file for better readability and organization! p.s keep up the great work, love the project!
I've updated the README to your requests, let me know if anything else needs improvement. I would like to mention that in my opinion the features section takes up too much of the readme, and decreases the readability quite a bit, however it's your project, so I mean this more of creative criticism. Hopefully this meets your standards. cheers
- UnitedPenguin
I wasn't quite sure what you meant about adding back the 'how to build' as all versions have had some sort of how to build, so I attempted to make a concise, but informative section with all the information in it.
It's not really my project, I'm just a member of the community trying to improve it. Hope that clears stuff up.
yea, i'm in the same boat, just like the projected so went to see if I could help out! Have a good one mate.
Ah ok, got it. I have plans for the next hour or so, but once I get back I can revise everything, and I'll read over it a few times to hopfully catch any miscommunications, or weird language. If there's anything else you need just write it here.
I've updated the README to your requests, let me know if anything else needs improvement. I would like to mention that in my opinion the features section takes up too much of the readme, and decreases the readability quite a bit, however it's your project, so I mean this more of creative criticism. Hopefully this meets your standards. cheers
* UnitedPenguin
It might be possible to either make it collapsible (like on modrinth) or put it in another file
It might be possible to either make it collapsible (like on modrinth) or put it in another file
I think thats do-able, if so would you want something that gives a small list of features with a link to the full set, or just a features section that has a clickable link?
It might be possible to either make it collapsible (like on modrinth) or put it in another file
I think thats do-able, if so would you want something that gives a small list of features with a link to the full set, or just a features section that has a clickable link?
If not required only having a single file reduces the maintenance burden (it probably won't be kept up to date either way but still) so that way would be preferred
apologies for the late reply, ive been sick. I will continute to finish the README tomorrow!
Personally i'd rather we didn't have a lot of prs involving the README. I guess this is fine as long as it wasn't written with AI :catstare:
You're welcome to re-open this pr should you be interested in finishing it, I do hope you haven't been sick for the entire past year though.