docs(core): update docs (#95)

Author: lyxyx

README.md

@@ -1,41 +1,80 @@
-## OneKey
+<p align="center">
+<img width="200" src="https://github.com/rayston92/graph_bed/blob/e3b2c938fc5b17d68531f69178908afb16266e6a/img/onekey_logo_badge_border.png?raw=trueg"/>
+</p>
 
- **🔑 OneKey is the smartest way to secure, buy, exchange and grow your crypto assets.** Learn more [here](https://www.onekey.so/).
+---
 
-----
+[![Github Stars](https://img.shields.io/github/stars/OneKeyHQ/firmware?t&logo=github&style=for-the-badge&labelColor=000)](https://github.com/OneKeyHQ/firmware/stargazers)
+[![Version](https://img.shields.io/github/release/OneKeyHQ/firmware.svg?style=for-the-badge&labelColor=000)](https://github.com/OneKeyHQ/firmware/releases)
+[![](https://img.shields.io/github/contributors-anon/OneKeyHQ/firmware?style=for-the-badge&labelColor=000)](https://github.com/OneKeyHQ/firmware/graphs/contributors)
+[![Last commit](https://img.shields.io/github/last-commit/OneKeyHQ/firmware.svg?style=for-the-badge&labelColor=000)](https://github.com/OneKeyHQ/firmware/commits/onekey)
+[![Issues](https://img.shields.io/github/issues-raw/OneKeyHQ/firmware.svg?style=for-the-badge&labelColor=000)](https://github.com/OneKeyHQ/firmware/issues?q=is%3Aissue+is%3Aopen)
+[![Pull Requests](https://img.shields.io/github/issues-pr-raw/OneKeyHQ/firmware.svg?style=for-the-badge&labelColor=000)](https://github.com/OneKeyHQ/firmware/pulls?q=is%3Apr+is%3Aopen)
+[![Discord](https://img.shields.io/discord/868309113942196295?style=for-the-badge&labelColor=000)](https://discord.gg/onekey)
+[![Twitter Follow](https://img.shields.io/twitter/follow/OneKeyHQ?style=for-the-badge&labelColor=000)](https://twitter.com/OneKeyHQ)
 
-![make something people want](https://github.com/rayston92/graph_bed/blob/edc43bc1cd6ce6a19f3b6c30624a4b58f6870d1f/img/github_home_bg.png?raw=true)
 
+## Community & Support
 
-## Repository Structure
+- [Community Forum](https://github.com/orgs/OneKeyHQ/discussions). Best for: help with building, discussion about best practices.
+- [GitHub Issues](https://github.com/OneKeyHQ/firmware/issues). Best for: bugs and errors you encounter using OneKey.
+- [Discord](https://discord.gg/onekey). Best for: sharing your ideas and hanging out with the community.
 
-* **[`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
 
+## 🚀 Getting Onboard
 
-## Contribute
+1. Install [poetry](https://python-poetry.org/)
+2. Install [nix](https://nixos.org/download.html)
+3. Pulling the latest code via the git command line tool,  setting up the development environment
 
-See [CONTRIBUTING.md](docs/misc/contributing.md).
+```
+  git clone --recurse-submodules https://github.com/OneKeyHQ/onekey-firmware.git
+  cd onekey-firmware
+  poetry install
+  nix-shell
+```
 
-Using [Conventional Commits](COMMITS.md) is strongly recommended and might be enforced in future.
+4. Run the build with:
 
-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.
+```
+   cd core && poetry run make build_unix
+```
 
-## Security vulnerability disclosure
+5. Now you can start the emulator
 
-Please report suspected security vulnerabilities in private to [[email protected]](mailto:[email protected]), Please do NOT create publicly viewable issues for suspected security vulnerabilities.
+```
+   poetry run ./emu.py
+```
 
-## Documentation
+6. You can now install the command line client utility to interact with the emulator
 
-See the `docs` folder or visit [docs.trezor.io](https://docs.trezor.io).
+```
+   cd python && poetry run python3 -m pip install .
+```
+
+## ✏ Contribute
+
+- Adding a small feature or a fix
+
+  If your change is somewhat subtle, feel free to file a PR in one of the appropriate repositories directly. See the PR requirements noted at [CONTRIBUTING.md](docs/misc/contributing.md)
+
+- Add new coin/token/network to the official onekey firmware
+
+  See [COINS.md](docs/misc/COINS.md)
+
+Also please have a look at the [docs](docs/SUMMARY.md) before contributing. The misc chapter should be read in particular because it contains some useful assorted knowledge.
+
+## 🔒 Security
+
+- Please read [Bug Bunty Rules](https://github.com/OneKeyHQ/app-monorepo/blob/onekey/docs/BUG_RULES.md), we have detailed the exact plan in this article.
+- Please report suspected security vulnerabilities in private to [email protected]
+- Please do NOT create publicly viewable issues for suspected security vulnerabilities.
+- As an open source project, although we are not yet profitable, we try to give some rewards to white hat hackers who disclose vulnerabilities to us in a timely manner.
+
+## ✨ Salute!
+
+[![](https://img.shields.io/github/contributors-anon/OneKeyHQ/firmware?style=for-the-badge&labelColor=000)](https://github.com/OneKeyHQ/firmware/graphs/contributors)
+
+<a href="https://github.com/onekeyhq/firmware/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=onekeyhq/firmware&max=240&columns=24"/>
+</a>

docs/SUMMARY.md

@@ -15,14 +15,13 @@
     - [SLIP-39](core/misc/slip0039.md)
     - [Exceptions usage](core/misc/exceptions.md)
     - [Memory fragmentation management](core/misc/fragmentation.md)
-- [Legacy](legacy/index.md)
 - [Python](python/index.md)
   - [trezorlib](python/trezorlib.md)
 - [Hardware](hardware/index.md)
-  - [Model T](hardware/model-t/index.md)
+  - [Model T(touch)](hardware/model-t/index.md)
     - [Boot stages](hardware/model-t/boot.md)
     - [Memory layout](hardware/model-t/memory.md)
-  - [Model One](hardware/model-one/index.md)
+  - [Model One(mini/classic)](hardware/model-one/index.md)
     - [Firmware format](hardware/model-one/firmware-format.md)
 - [Common](common/index.md)
   - [Communication](common/communication/index.md)
@@ -38,9 +37,7 @@
   - [UI Tests](tests/ui-tests.md)
   - [Click Tests](tests/click-tests.md)
 - [CI](ci/index.md)
-  - [GitLab CI Jobs](ci/jobs.md)
 - [Miscellaneous](misc/index.md)
-  - [Affected third-parties](misc/third-parties.md)
   - [Coins' BIP-44 Paths](misc/coins-bip44-paths.md)
   - [Contributing](misc/contributing.md)
   - [FW update and device wipe](misc/update-wipes.md)
@@ -50,3 +47,4 @@
   - [Review Process](misc/review.md)
   - [Changelog](misc/changelog.md)
   - [TOIF Image Format](misc/toif.md)
+  - [COINS](misc/COINS.md)

docs/book.toml

@@ -1,6 +1,6 @@
 [book]
-title = "Trezor Firmware"
-description = "Documentation of Trezor Firmware."
+title = "Onekey Firmware"
+description = "Documentation of Onekey Firmware."
 src = "."
 
 [build]

docs/ci/index.md

@@ -1,7 +1,3 @@
 # CI
 
-The complete test suite is running on a public [GitLab CI](https://gitlab.com/satoshilabs/trezor/trezor-firmware). We currently do not have a CI for external contributors. If needed we will repush your PR to enable the CI.
-
-See this [list](jobs.md) of CI jobs descriptions for more info.
-
-The CI folder contains all the .yml GitLab files that are included in the main `.gitlab.yml` to provide some basic structure. All GitLab CI Jobs run inside a docker image, which is built using the present `Dockerfile`. This image is stored in the GitLab registry.
+The complete test suite is running on a public [GitLab CI](https://github.com/OneKeyHQ/firmware). We currently do not have a CI for external contributors. If needed we will repush your PR to enable the CI.