There is no README for core
#2758
Closed
DreepyYunky
started this conversation in
Ideas/Requests
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
PROBLEM
So I've noticed that
core
lacks aREADME.md
file.vendor
comes with aREADME.md
So, why does it matter
I think it matters for documentation.
Think about the README for
vendor
, It comes with a simple descriptions of the bindings invendor
. This will make it easy for someone to read up on the bindings.WHY SHOULDN'T THAT APPLY TO CORE?
I think it's more important that
core
. Think about it, avendor
binding has a quick simple name likevendor:sdl2
, You'll easily know It's a binding of SDL2. Butcore:c
won't bring up much in your mind. I think a README will be a quick way to invite people tocore
The Solution
A simple
README.md
would be enough. It can go somewhat like thisFmt
Formatted I/O for Odin.
Etc for Other parts of
core:
Just so you know
Yes, I know descriptions are on Odin's package docs. But I still think this is important
Beta Was this translation helpful? Give feedback.
All reactions