Improve README file

[wusatosi]

Fix #97 .

Major painpoints in current README:

• Current README is full of TODOs
• Not all of our developer tools have been documented (pre-commit, CMake preset, codespace)
• A lot of replacement needed to bootstrap a new project

This PR aim to fix these issues.

Major TODOs

• Address all current TODOs, mostly left out explicitly to @neatudarius
• Define minimal C++ version
• Define minimal CMake version
• Define tested range of compiler support
• Document that cmake config requires internet access due to testing
• Document CMake config flags: Disable Tests
• Document CMake config flags: Disable examples
• Document codespace support as rapid development
• Document CMake preset as one-line configuration
• Document developer facing tool: pre-commit
• Document developer facing tool: Current GitHub Action workflow and how to update them.

[bretbrownjr]

Made a few suggestions. I like the notes you left to yourself.

I am definitely looking forward to the docs on pre-commit and how to run GitHub Actions locally. If our Spaces environment comes already prepared for those workflows, even better.

One suggestion: it's probably true that more users will just want to consume and build Beman libraries than make changes to them. Let's consider creating a CONTRIBUTING.md file and putting instructions in there that you wouldn't need if you were happy just building a release of this repo.

[bretbrownjr]

Please remind me to update this section of the README whenever we decide on an approach to make the http-based dependency resolution optional.

[wusatosi]

One suggestion: it's probably true that more users will just want to consume and build Beman libraries than make changes to them. Let's consider creating a CONTRIBUTING.md file and putting instructions in there that you wouldn't need if you were happy just building a release of this repo.

Yeah one of the main goal is to minimize the amount of replacement we need for the initial setup. We don't have to be exhaustive with those.