I'm not the original commenter you replied to, but I have thoughts that might be relevant. These things are quite subjective so some people will disagree that this is a good example, or with what I'm about to say so have a punch of salt at the ready…
I think "pretty average" is the thing to strive for in a README. The right balance of detailed but concise, not overly festooned with unnecessary verbiage like a stereotypical recipe page, a simple "what is it", "key features", "how to get/install", "more detail on features / example use" structure.
Of course it gets harder to find that balance as the size and scope of a project expands, you have to become judicious with cutting things out and excising them to extended documentation instead of everything being in the README. For a thing this size everything is close to the right balance if you word+arrange it right, for larger projects the README should be a summary of what, how to get, and where the other documentation is.
If this one is AI written (there are signs, but those are things humans have long done which is why AIs copy them) it has been human edited rather than just thrown up as-is.
> as someone who struggles to write readmes
If you are struggling a lot with that, perhaps you are overthinking it or trying to shoehorn in too much detail?
Well done, any plans to show other space objects too? Like the ISS or Starlink? One thing I ran into when tracking satellites in the browser: CelesTrak's TLE files skip satellites with six-digit catalog numbers, which is most of what's been launched lately, so new Starlinks just weren't there. Their CSV files have them tho.
Not as-is, looking at the options list there seems to be no way to ask it to output one frame then exit. That would presumably be an easy option to add.
After reading the first sentence, I cannot stop imagining some Rust people cannot stop salivating at the prospect to a version saying, "written in Rust", "safe", etc. ~
Not really. One example image has Capella, Rigel, and Sirius clearly marked. But even with that, I can not make out Orion, probably the most recognizable constellation behind the big dipper.
I would absolutely love a terminal Stellarium alternative, but this isn't it.
Having stars and planets at your fingertips...
[0] https://www.casio.com/us/watches/50th/Heritage/1980s/
I took note of your suggestion, next time I will write the README in the voice of da-luce/astroterm README.
(Curious as someone who struggles to write readmes)
I think "pretty average" is the thing to strive for in a README. The right balance of detailed but concise, not overly festooned with unnecessary verbiage like a stereotypical recipe page, a simple "what is it", "key features", "how to get/install", "more detail on features / example use" structure.
Of course it gets harder to find that balance as the size and scope of a project expands, you have to become judicious with cutting things out and excising them to extended documentation instead of everything being in the README. For a thing this size everything is close to the right balance if you word+arrange it right, for larger projects the README should be a summary of what, how to get, and where the other documentation is.
If this one is AI written (there are signs, but those are things humans have long done which is why AIs copy them) it has been human edited rather than just thrown up as-is.
> as someone who struggles to write readmes
If you are struggling a lot with that, perhaps you are overthinking it or trying to shoehorn in too much detail?
After reading the first sentence, I cannot stop imagining some Rust people cannot stop salivating at the prospect to a version saying, "written in Rust", "safe", etc. ~
I would absolutely love a terminal Stellarium alternative, but this isn't it.