chore(docs): adjust description of `core` in readme
What the developer wrote
Authored by M1nd3r
chore(docs): adjust description of `core` in readme
- Adjusted description of `core`, because it contains firmware implementation for Trezor Safe models, too - not only Trezor T.
- Added few minor readme fixes.
[no changelog]
What changed, and why it matters
This commit only updates the project's README file. It expands the description of the 'core' folder to mention additional Trezor Safe hardware models and makes minor grammar and formatting fixes. There are no code or security changes.
No security action needed. This is a documentation-only change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff is limited to README.md. It changes one bullet point describing the core/ directory from ‘firmware implementation for Trezor T’ to ‘firmware implementation for Trezor T, Trezor Safe 3, Trezor Safe 5, and Trezor Safe 7’, removes an extra blank line, and applies small wording/punctuation edits in the ‘Contribute’ and ‘Security vulnerability disclosure’ sections. No source code, build scripts, cryptographic, or protocol changes are present.
Changed components
Inspect captured patch +4 / −5
diff --git a/README.md b/README.md
index 29cbc394..a0543d1c 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@
* **[`common/defs`](common/defs/)**: JSON coin definitions and support tables
* **[`common/protob`](common/protob/)**: Common protobuf definitions for the Trezor protocol
* **[`common/tools`](common/tools/)**: Tools for managing coin definitions and related data
-* **[`core`](core/)**: Trezor Core, firmware implementation for Trezor T
+* **[`core`](core/)**: Trezor Core, a firmware implementation for Trezor T, Trezor Safe 3, Trezor Safe 5, and Trezor Safe 7
* **[`crypto`](crypto/)**: Stand-alone cryptography library used by both Trezor Core and the Trezor One firmware
* **[`docs`](docs/)**: Assorted documentation
* **[`legacy`](legacy/)**: Trezor One firmware implementation
@@ -18,16 +18,15 @@
* **[`tools`](tools/)**: Miscellaneous build and helper scripts
* **[`vendor`](vendor/)**: Submodules for external dependencies
-
## Contribute
See [CONTRIBUTING.md](docs/misc/contributing.md).
-Using [Conventional Commits](COMMITS.md) is strongly recommended and might be enforced in future.
+Using [Conventional Commits](COMMITS.md) is strongly recommended and might be enforced in the future.
-Also please have a look at the docs, either in the `docs` folder or at [docs.trezor.io](https://docs.trezor.io) before contributing. The [misc](docs/misc/index.md) chapter should be read in particular because it contains some useful assorted knowledge.
+Also, please have a look at the docs, either in the `docs` folder or at [docs.trezor.io](https://docs.trezor.io) before contributing. The [misc](docs/misc/index.md) chapter should be read in particular, as it contains useful assorted knowledge.
-## Security vulnerability disclosure
+## Security Vulnerability Disclosure
Please do NOT create publicly viewable issues for suspected security vulnerabilities. See the [Security tab](https://github.com/trezor/trezor-firmware/security/policy) for reporting instructions.
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.