From ff208deecea3bb48c20e22e8240a0823dc54e780 Mon Sep 17 00:00:00 2001 From: Mingshen Sun Date: Thu, 26 Mar 2020 00:00:31 -0700 Subject: [PATCH] Add tagging convention in README --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fdd719f5..e506fbe7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -## Current Branch +## Branch -- `master`: Teaclave SGX SDK 1.1.0 and Intel SGX SDK 2.7.1 +- `master`/`sgx1.1.0`: Teaclave SGX SDK 1.1.0 (Intel SGX SDK 2.7.1) ## Version @@ -8,3 +8,15 @@ Given a version number X.Y.Z, increment: - X when making incompatible structural/API changes - Y when updating Teaclave SGX SDK - Z when adding, updating, deprecating and deleting crates + +For example: + +- crates-sgx 0.1.0: Teaclave SGX SDK 1.1.0 (Intel SGX SDK 2.7.1) + 10 SGX crates +- crates-sgx 0.1.1: Teaclave SGX SDK 1.1.0 (Intel SGX SDK 2.7.1) + 20 SGX crates +- crates-sgx 0.2.0: Teaclave SGX SDK 1.2.0 (Intel SGX SDK 2.8) + 20 SGX crates + +## Tag + +Tag follows this convention `v{x.y.z}+sgx{x.y.z}`, where: +- `v{x.y.z}` is the version of crates-sgx +- `sgx{x.y.z}` is the version of Teaclave SGX SDK