This is an automated email from the ASF dual-hosted git repository.
zfc pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-teaclave-sgx-sdk.git
The following commit(s) were added to refs/heads/main by this push:
new dceb9c11 polish readme.md
dceb9c11 is described below
commit dceb9c11c7bd8a93019b8f9253437c785b808edb
Author: Zhaofeng Chen <[email protected]>
AuthorDate: Sun Jul 20 04:20:51 2025 +0000
polish readme.md
---
README.md | 82 +++++++++++++++++++++++++++++++++++++++++----------------------
1 file changed, 54 insertions(+), 28 deletions(-)
diff --git a/README.md b/README.md
index 02241021..7d9a60f5 100644
--- a/README.md
+++ b/README.md
@@ -1,37 +1,63 @@
-# Teaclave SGX SDK v2.0 preview
+# Teaclave SGX SDK
-Teaclave SGX SDK v2.0 is a revamped version. It is much more developer friendly
-compared to v1.1.
+[](LICENSE)
+[](https://teaclave.apache.org/)
-- supports `cargo build` + `no_std`, `xargo build` and `cargo-std-aware` mode.
-- Tokio and Tonic is directly available to enclave programming without any
change.
-- Refactored Intel's SDK using Rust. Only a small portion of Intel's SDK is
required.
-- Improved testing framework. `sgx_tstd` is well tested now.
-- No need to maintain 100+ 3rd party dependencies. Most dependencies are
`use`-able without any change.
+**Apache Teaclave SGX SDK** is a Rust SDK for developing Intel SGX
applications. It enables developers to write secure, privacy-preserving
applications using Intel Software Guard Extensions (SGX) technology with the
safety and performance benefits of the Rust programming language.
-## Build system
+## Overview
-We still maintain the legacy `no_std` cargo build support, and `xargo build`
with a customized sysroot. v2.0 supports `cargo-std-aware` as well.
+The Apache Teaclave SGX SDK provides a comprehensive development environment
for building Intel SGX enclaves in Rust. The current version (v2.0) offers
significant improvements over the [legacy
v1.1](https://github.com/apache/incubator-teaclave-sgx-sdk/tree/master) ,
including:
-To switch from these build modes, please specify
-- `BUILD_STD=no` to use traditional `no_std` cargo build
-- `BUILD_STD=cargo` (default setting) to use the new std aware cargo build
-- `BUILD_STD=xargo` to use xargo build
+- **Modern Build System**: Supports `cargo build` with `no_std`, `xargo
build`, and `cargo-std-aware` modes
+- **Rich Ecosystem**: Direct support for Tokio and Tonic in enclave
programming without modifications
+- **Lightweight Architecture**: Refactored Intel's SGX SDK using Rust,
requiring only a minimal portion of Intel's original SDK
+- **Robust Testing**: Comprehensive testing framework with well-tested
`sgx_tstd` standard library
+- **Simplified Dependencies**: Eliminates the need to maintain 100+
third-party dependencies; most Rust crates work without modifications
+## Build System
-## Samples
+The SDK supports multiple build modes to accommodate different development
preferences:
-We are still working on porting all v1.1 samples to v2.0. Current available
samples include:
+- **`BUILD_STD=cargo`** (default): Uses the new std-aware cargo build system
+- **`BUILD_STD=no`**: Traditional `no_std` cargo build for minimal footprint
+- **`BUILD_STD=xargo`**: Uses xargo build with customized sysroot
-- backtrace
-- cov
-- crypto
-- hellworld
-- httpreq
-- hyper-rustls-https-server
-- logger
-- regex
-- rpc (Tonic + Tokio)
-- seal
-- switchless
-- zlib-lazy-static-sample
+## Sample Applications
+
+The following sample applications demonstrate various SGX SDK capabilities:
+
+- **backtrace**: Stack trace functionality in SGX enclaves
+- **cov**: Code coverage analysis tools
+- **crypto**: Cryptographic operations within enclaves
+- **helloworld**: Basic SGX enclave example
+- **httpreq**: HTTP client functionality
+- **hyper-rustls-https-server**: HTTPS server using Hyper and Rustls
+- **logger**: Logging capabilities for SGX applications
+- **regex**: Regular expression processing
+- **rpc**: Remote procedure calls using Tonic and Tokio
+- **seal**: Data sealing and unsealing operations
+- **switchless**: Switchless call optimization
+- **zlib-lazy-static-sample**: Compression with lazy static initialization
+
+*Note: Migration of additional v1.1 samples to v2.0 is ongoing.*
+
+## Getting Started
+
+For detailed installation instructions, development guides, and API
documentation, please visit:
+
+- **Project Website**:
[https://teaclave.apache.org/](https://teaclave.apache.org/)
+- **Documentation**: [Teaclave SGX SDK
Documentation](https://teaclave.apache.org/sgx-sdk-docs/)
+- **API Reference**: [Teaclave SGX SDK API
Reference](https://teaclave.apache.org/api-docs/sgx-sdk/)
+
+## Contributing
+
+Teaclave is developed in the open following [The Apache
Way](https://www.apache.org/theapacheway/). We strive to maintain a project
that is community-driven and inclusive.
+
+We welcome all forms of contributions. Please refer to our [Contributing
Guide](https://teaclave.apache.org/contributing) for more information. A big
thank-you to all our [contributors](https://teaclave.apache.org/contributors/)!
+
+## Community
+
+- 📬 Join our [mailing
list](https://lists.apache.org/[email protected])
+- 🐦 Follow us on [Twitter @ApacheTeaclave](https://twitter.com/ApacheTeaclave)
+- 🌐 Learn more at
[teaclave.apache.org/community](https://teaclave.apache.org/community/)
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
