trezor-firmware/README.md

# Trezor Firmware

![img](https://repository-images.githubusercontent.com/180590388/968e6880-6538-11e9-9da6-4aef78157e94)

## Repository Structure

* **[`ci`](ci/)**: [Gitlab CI](https://gitlab.com/satoshilabs/trezor/trezor-firmware) configuration files
* **[`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
* **[`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
* **[`python`](python/)**: Python [client library](https://pypi.org/project/trezor) and the `trezorctl` command
* **[`storage`](storage/)**: NORCOW storage implementation used by both Trezor Core and the Trezor One firmware
* **[`tests`](tests/)**: Firmware unit test suite
* **[`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.

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.

## Security vulnerability disclosure

Please report suspected security vulnerabilities in private to [security@satoshilabs.com](mailto:security@satoshilabs.com), also see [the disclosure section on the Trezor.io website](https://trezor.io/security/). Please do NOT create publicly viewable issues for suspected security vulnerabilities.

## Documentation

See the `docs` folder or visit [docs.trezor.io](https://docs.trezor.io).
add README 2019-05-14 13:39:03 +00:00			`# Trezor Firmware`

fix typo 2019-05-14 13:42:42 +00:00			`![img](https://repository-images.githubusercontent.com/180590388/968e6880-6538-11e9-9da6-4aef78157e94)`
fix typo, add image 2019-05-14 13:41:09 +00:00
docs: improve docs, add random.md 2019-10-24 11:36:54 +00:00			`## Repository Structure`

readme: add link to GitLab CI 2019-10-25 13:32:56 +00:00			* [`ci`](ci/): [Gitlab CI](https://gitlab.com/satoshilabs/trezor/trezor-firmware) configuration files
docs: improve docs, add random.md 2019-10-24 11:36:54 +00:00			* [`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
			* [`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
			* [`python`](python/): Python [client library](https://pypi.org/project/trezor) and the `trezorctl` command
			* [`storage`](storage/): NORCOW storage implementation used by both Trezor Core and the Trezor One firmware
			* [`tests`](tests/): Firmware unit test suite
			* [`tools`](tools/): Miscellaneous build and helper scripts
			* [`vendor`](vendor/): Submodules for external dependencies


add README 2019-05-14 13:39:03 +00:00			`## Contribute`

readme: fix link to Contributing 2020-04-30 13:03:56 +00:00			`See [CONTRIBUTING.md](docs/misc/contributing.md).`
add README 2019-05-14 13:39:03 +00:00
docs: introduce conventional-commits (#1234) 2020-09-15 14:11:39 +00:00			`Using [Conventional Commits](COMMITS.md) is strongly recommended and might be enforced in future.`

docs: move docs to root 2019-12-06 08:56:38 +00:00			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.
docs: improve docs, add random.md 2019-10-24 11:36:54 +00:00
docs: move docs to root 2019-12-06 08:56:38 +00:00			`## Security vulnerability disclosure`
add README 2019-05-14 13:39:03 +00:00
fix typo 2019-05-14 13:48:39 +00:00			`Please report suspected security vulnerabilities in private to [security@satoshilabs.com](mailto:security@satoshilabs.com), also see [the disclosure section on the Trezor.io website](https://trezor.io/security/). Please do NOT create publicly viewable issues for suspected security vulnerabilities.`
add README 2019-05-14 13:39:03 +00:00
docs: move docs to root 2019-12-06 08:56:38 +00:00			`## Documentation`

			See the `docs` folder or visit [docs.trezor.io](https://docs.trezor.io).