search

lcn2 / calc

C-style arbitrary precision calculator
http://www.isthe.com/chongo/tech/comp/calc/index.html
Other
346 stars 52 forks source link

Print usage on top #80

Closed john-peterson closed 1 year ago

john-peterson commented 1 year ago

It's common practice nowadays to put this on the very top

A text that can be copied to the terminal an "it just works"

Will bring many back to the roots of computers after over commercialisation of the over hyped "desktop experience" of the 90s

And an equal over hyping of the "app experience" in the 10s. Text is just fine

lcn2 commented 1 year ago

We can see it both ways. Nevertheless, as README.md is just documentation, your idea is fine too.

We have a number of other repos for which you suggestion might apply, @john-peterson, some of which we only co-manage. As such, if we were make such a similar suggestion for other repos it would helpful to "site some best practice" when making the change/

Is there a "style or best practice guide" URL you could provide?

Another issue we see with your modification is that it assumes an "apt" based system. Yes, it does say "Debian/Ubuntu", but shouldn't one address other installers such as "yum" and "dnf"?

We might update your patch after accepting this pull request.

UPDATE 0

With commit 15be1dec4d6c2dcc228edb2144a22fb23cd357f9 we expanded on the TL;DR install and run sections.

The calc tool runs on a very wide variety of operating systems and platforms. It would be too much to include them all, nor useful to most people if we did. We added a few of the more common ones.

Suggestions and corrections welcome.