[incubator-teaclave] branch master updated: Polish document (#431)

[yu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

yulongzhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-teaclave.git


The following commit(s) were added to refs/heads/master by this push:
     new e9968bc  Polish document (#431)
e9968bc is described below

commit e9968bc7f1e13270f90a44b09cecc219fc56648c
Author: Mingshen Sun <bo...@mssun.me>
AuthorDate: Wed Nov 4 15:51:38 2020 -0800

    Polish document (#431)
    
    * Polish document
    
    * Add symptom of OOM
---
 README.md                 | 10 +++++-----
 docs/README.md            |  2 +-
 docs/my-first-function.md | 13 +++++++++++++
 3 files changed, 19 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 1f11be1..4869f6f 100644
--- a/README.md
+++ b/README.md
@@ -8,23 +8,23 @@ platform, making computation on privacy-sensitive data safe and simple.
 
 ## Highlights
 
-- **Security**:
+- **Secure and Attestable**:
   Teaclave adopts multiple security technologies to enable secure computing, in
   particular, Teaclave uses Intel SGX to serve the most security-sensitive tasks
   with *hardware-based isolation*, *memory encryption* and *attestation*.
   Also, Teaclave is written in Rust to prevent *memory-safety* issues.
-- **Functionality**:
+- **Function-as-a-Service**:
   Teaclave is provided as a *function-as-a-service platform*. With many built-in
   functions, it supports tasks like machine learning, private set intersection,
   crypto computation, etc. In addition, developers can also deploy and execute
   Python scripts in Teaclave. More importantly, unlike traditional FaaS,
   Teaclave supports both general secure computing tasks and *flexible
   single- and multi-party secure computation*.
-- **Usability**:
+- **Ease of Use**:
   Teaclave builds its components in containers, therefore, it supports
   deployment both locally and within cloud infrastructures. Teaclave also
   provides convenient endpoint APIs, client SDKs and command line tools.
-- **Modularity**:
+- **Flexibility**:
   Components in Teaclave are designed in modular, and some like remote
   attestation can be easily embedded in other projects. In addition, Teaclave
   SGX SDK can also be used separately to write standalone SGX enclaves for other
@@ -37,7 +37,7 @@ platform, making computation on privacy-sensitive data safe and simple.
 - [My First Function](docs/my-first-function.md)
 - [Write Functions in Python](docs/functions-in-python.md)
 - [How to Add Built-in Functions](docs/builtin-functions.md)
-- [Deploying Teaclave on Azure Confidential Computing Virtual Machines](docs/azure-confidential-computing.md)
+- [Deploying Teaclave on Azure Confidential Computing VM](docs/azure-confidential-computing.md)
 
 ### Design
 
diff --git a/docs/README.md b/docs/README.md
index 3840b47..46926f7 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -9,7 +9,7 @@ permalink: /docs/
 - [My First Function](my-first-function.md)
 - [Function in Python](functions-in-python.md)
 - [How to Add Built-in Functions](builtin-functions.md)
-- [Deploying Teaclave on Azure Confidential Computing Virtual Machines](azure-confidential-computing.md)
+- [Deploying Teaclave on Azure Confidential Computing VM](azure-confidential-computing.md)
 
 ## Design
 
diff --git a/docs/my-first-function.md b/docs/my-first-function.md
index 2885e8a..48cc34f 100644
--- a/docs/my-first-function.md
+++ b/docs/my-first-function.md
@@ -192,6 +192,10 @@ $ PYTHONPATH=../../sdk/python python3 mesapy_echo.py mesapy_echo_payload.py 'Hel
 ## Simulation Mode
 
 Clone and build Teaclave (with the `-DSGX_SIM_MODE=ON` option in `cmake`).
+Note that if you are using Docker for Mac,
+[increase the size of allocated memory](https://docs.docker.com/docker-for-mac/) to
+avoid compilation error caused by out-of-memory, e.g., reporting a "signal: 9,
+SIGKILL: kill" error during the compilation.
 
 ```
 $ git clone https://github.com/apache/incubator-teaclave.git
@@ -226,4 +230,13 @@ In simulation mode, run examples with `SGX_MODE=SW` environment variable.
 ```
 $ cd examples/python
 $ SGX_MODE=SW PYTHONPATH=../../sdk/python python3 builtin_echo.py 'Hello, Teaclave!'
+[+] registering user
+[+] login
+[+] registering function
+[+] creating task
+[+] approving task
+[+] invoking task
+[+] getting result
+[+] done
+[+] function return:  b'Hello, Teaclave!'
 ```


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@teaclave.apache.org
For additional commands, e-mail: commits-help@teaclave.apache.org