Some updates to shell scripts

sharkdp / insect

High precision scientific calculator with support for physical units

https://numbat.dev/

MIT License

3.18k stars 126 forks source link

Some updates to shell scripts #317

Closed triallax closed 2 years ago

triallax commented 2 years ago

Make docs/generate.sh executable
Use gfm instead of deprecated markdown_github
Remove .sh extension from scripts

sharkdp commented 2 years ago

I guess this doesn't change anything in the output?

By the way: I think it should be easily possible to write a CI check that runs docs/generate and verifies that the generated README.md is up to date. This way, we would spot if someone accidentally modifies README.md. Or forgets to run docs/generate. What do you think?

triallax commented 2 years ago

I guess this doesn't change anything in the output?

It doesn't seem to at least.

By the way: I think it should be easily possible to write a CI check that runs docs/generate and verifies that the generated README.md is up to date. This way, we would spot if someone accidentally modifies README.md. Or forgets to run docs/generate. What do you think?

Sounds good to me.