This is an automated email from the ASF dual-hosted git repository.
mssun pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/incubator-teaclave-trustzone-sdk.git
The following commit(s) were added to refs/heads/master by this push:
new 80bcf5a Polish README.md (#46)
80bcf5a is described below
commit 80bcf5a4cbed11ae036181c2153392de78e7306e
Author: Mingshen Sun <[email protected]>
AuthorDate: Tue Oct 19 13:14:57 2021 -0700
Polish README.md (#46)
---
README.md | 27 ++++++++++++++++++++-------
docs/README.md | 4 ++--
2 files changed, 22 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index 72f8323..d5cd63d 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,9 @@
# Teaclave TrustZone SDK
+[](LICENSE)
+[](https://github.com/apache/incubator-teaclave-trustzone-sdk/releases)
+[](https://teaclave.apache.org/)
+
Teaclave TrustZone SDK (Rust OP-TEE TrustZone SDK) provides abilities to build
safe TrustZone applications in Rust. The SDK is based on the
[OP-TEE](https://www.op-tee.org/) project which follows
@@ -79,11 +83,12 @@ Please read detailed
to run these examples on OP-TEE for QEMU. For other supported devices, please
find
more documents
[here](https://optee.readthedocs.io/en/latest/general/platforms.html).
-## Contributing
+## Documentation
-Teaclave TrustZone SDK is open source in [The Apache
Way](https://www.apache.org/theapacheway/),
-we aim to create a project that is maintained and owned by the community. All
-kinds of contributions are welcome. Thanks to our
[contributors](https://teaclave.apache.org/contributors/).
+- [Getting Started with OPTEE for QEMU
ARMv8](docs/getting-started-with-optee-for-qemu-armv8.md)
+- [Overview of OP-TEE Rust Examples](docs/overview-of-optee-rust-examples.md)
+- [Host API
Reference](https://teaclave.apache.org/api-docs/trustzone-sdk/optee-teec/)
+- [TA API
Reference](https://teaclave.apache.org/api-docs/trustzone-sdk/optee-utee/)
## Publication
@@ -103,7 +108,15 @@ Here is the BiBTeX record for your reference.
}
```
-## License
+## Contributing
+
+Teaclave is open source in [The Apache
Way](https://www.apache.org/theapacheway/),
+we aim to create a project that is maintained and owned by the community. All
+kinds of contributions are welcome.
+Thanks to our [contributors](https://teaclave.apache.org/contributors/).
+
+## Community
-Teaclave TrustZone SDK is distributed under the Apache License (Version 2.0).
-See [LICENSE](LICENSE) for details.
+- Join us on our [mailing
list](https://lists.apache.org/[email protected]).
+- Follow us at [@ApacheTeaclave](https://twitter.com/ApacheTeaclave).
+- See [more](https://teaclave.apache.org/community/).
diff --git a/docs/README.md b/docs/README.md
index 2bfd2ca..81bf4a9 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -4,5 +4,5 @@ permalink: /trustzone-sdk-docs
# Teaclave TrustZone SDK Documentation
-* [Getting Started with OPTEE for QEMU
ARMv8](/trustzone-sdk-docs/getting-started-with-optee-for-qemu-armv8)
-* [Overview of OP-TEE Rust
Examples](/trustzone-sdk-docs/overview-of-optee-rust-examples)
+* [Getting Started with OPTEE for QEMU
ARMv8](getting-started-with-optee-for-qemu-armv8.md)
+* [Overview of OP-TEE Rust Examples](overview-of-optee-rust-examples.md)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
