chore: Improve README #61
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
apljungquist
force-pushed
the
improve_readme
branch
from
34e2448
to
d70847b
Compare
apljungquist
force-pushed
the
improve_readme
branch
5 times, most recently
from
ef4cb2f
to
168fcea
Compare
The main goals of this change are: - Improve consistency. - Make it easier to relate this project to the official developer offering.
apljungquist
force-pushed
the
improve_readme
branch
3 times, most recently
from
53c0fa8
to
67eb16e
Compare
* upstream/main: (48 commits) chore: Use workspace dependencies consistently (#126) fix(axevent_example): Return `Break` from signal handlers (#125) chore(deps): bump ghcr.io/devcontainers/features/common-utils (#124) feat(device-manager): Allow unsigned ACAPs (#122) feat(acap-build): Enable bypassing `acap-build` (#119) chore: streamline CI (#118) fix: Don't invalidate Cargo caches (#117) fix(acap-ssh-utils): Warn users that commands may break (#114) feat: Factor out `acap-build` wrapper to lib crate (#112) feat: Add `fleet-manager` program (#111) feat: Add edge storage wrapper and example (#108) fix: Measure apparent size (#107) chore(acap-logging): Bump version (#106) fix(cargo-acap-sdk): Set executable bits (#105) fix(acap-logging)!: Disable default features for env_logger (#103) chore: Track size of apps (#102) chore: Don't use clearly defined for license info (#101) Update rust toolchain to 1.80.1 (#100) fix!: Make builds reproducible in dev-container (#99) feat(axevent)!: Use generic callbacks and remove leak (#59) ...
`README.md`: - Use the terms alpha and beta because I expect most readers to infer that alpha is less mature than beta and that both indicate that the software is unfinished. I previously called this experimental and unstable respectively because I worry some readers may have specific ideas of what alpha and beta means, but my gut feeling is that introducing novel terms would do more harm than good. - Replace tables with nested lists to make the document easier to read and edit as plain text.
apljungquist
force-pushed
the
improve_readme
branch
from
6be1142
to
5e174ff
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The main goals of this change are: