From 2a2eb217a71f74cd2fadb615c73fb0e5cd8a87f6 Mon Sep 17 00:00:00 2001 From: Jun Kimura Date: Fri, 13 Sep 2024 12:31:33 +0900 Subject: [PATCH] update README --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bfcf8ad..41b770c 100644 --- a/README.md +++ b/README.md @@ -53,18 +53,30 @@ This repository contains multiple modules: ## Build enclave and run E2E test +### Prerequisites + +You need to install the Intel SGX SDK for your environment: +```bash +$ curl -LO https://download.01.org/intel-sgx/sgx-linux/2.19/distro/ubuntu22.04-server/sgx_linux_x64_sdk_2.19.100.3.bin +$ chmod +x ./sgx_linux_x64_sdk_2.19.100.3.bin +$ echo -e 'no\n/opt' | ./sgx_linux_x64_sdk_2.19.100.3.bin +$ source /opt/sgxsdk/environment +``` + ### SGX HW mode(default) ``` -$ make all yrly prepare-contracts build-images +$ make yrly prepare-contracts build-images $ make e2e-test ``` -### SGX SW mode +### SGX SW mode(for non-SGX supported environment) + +This mode is for non-SGX supported environment. This doesn't require SGX hardware and driver, but the enclave is not secure. ``` $ export SGX_MODE=SW -$ make all yrly prepare-contracts build-images +$ make yrly prepare-contracts build-images $ make e2e-test ```