List backends in README as a table#741
List backends in README as a table#741david-vanderson merged 11 commits intodavid-vanderson:mainfrom
Conversation
Slightly overhauls existing README
Allow titles to be a parent bullet point
* Moved and edited Zig link * Shortened a table entry * A comma typo
Overlooked remaining asterisks become hyphens
|
Here's the new view for an easy comparison. |
|
I'm pretty happy with how it looks, after getting the table narrower. Still need to look into those TODO's. I might punt on them though. Not sure it's worth putting info about webgl2 vs webgl. I think almost everything uses webgl2 now, and anybody who cares knows what they are looking for. |
See follow-up reply
Self-explanatory, for the sake of consistency
|
Following your changes:
Completely new changes:
I'll use the GitHub feature to comment within the actual code next time, as we narrow down the changes necessary. |
|
We are getting to the really small stuff now, so mostly less important than getting this done. Mostly my changes are geared towards people reading quickly.
That makes sense, but visually it looks weird to have them be different.
I see where you're coming from, but it's too much text for people just starting out. I want to give them something to immediately run first, then follow up with the table. I'll try to put a link to either the get started part or dvui-demo there.
I don't care all that much, but generally less is better (so no colons). Usually I refrain from starting with a capital unless it's a full sentence, or it reads like a title. But again this is very minor.
I still don't have a good opinion on this. A lot of capitals looks disruptive in a sentence, especially "DVUI". I guess we shoot for lowercase and see how it goes? I'll make a few followups and then merge it. We can always update stuff later. |
|
No problem, I recognise that you have actual features to fulfill. Don't forget to remove all the TODOs or comment out the ones which aren't already. |
|
The plural thing was for both SDL and web, so two different backends. Right? I have on my list to follow this up with:
I know we didn't get to all the stuff you wanted, but this is a good improvement. I really appreciate the detailed work here. Thank you! |
This PR originates from #678 (reply in thread), where I had reordered all README-listed backends into a table. No contents were otherwise removed, though repetition of demo link, docs link, and "external Markdown files" links was omitted.
Changes:
coderaylib_zig_custom.mdfile to use dashes:I ended up avoiding TODO-like lists as advised. In the README, not here.
Opinions are welcome, especially those about:
Standalone,On top, andAs appin the table#Floating Windowswhich didn't actually link. I assume it's a Markdown thingTODO, which is why this PR is originally being submitted as a draftI didn't really have all that much to add, but I did notice the lack of mention for WebGL 2 being different from WebGL without mipmaps. Web backend is only referred to as
Webbackend in README, see last TODO left in README. Could just be me though.