Skip to content

Commit ff208de

Browse files
committed
Add tagging convention in README
1 parent c8ddbb9 commit ff208de

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,22 @@
1-
## Current Branch
1+
## Branch
22

3-
- `master`: Teaclave SGX SDK 1.1.0 and Intel SGX SDK 2.7.1
3+
- `master`/`sgx1.1.0`: Teaclave SGX SDK 1.1.0 (Intel SGX SDK 2.7.1)
44

55
## Version
66

77
Given a version number X.Y.Z, increment:
88
- X when making incompatible structural/API changes
99
- Y when updating Teaclave SGX SDK
1010
- Z when adding, updating, deprecating and deleting crates
11+
12+
For example:
13+
14+
- crates-sgx 0.1.0: Teaclave SGX SDK 1.1.0 (Intel SGX SDK 2.7.1) + 10 SGX crates
15+
- crates-sgx 0.1.1: Teaclave SGX SDK 1.1.0 (Intel SGX SDK 2.7.1) + 20 SGX crates
16+
- crates-sgx 0.2.0: Teaclave SGX SDK 1.2.0 (Intel SGX SDK 2.8) + 20 SGX crates
17+
18+
## Tag
19+
20+
Tag follows this convention `v{x.y.z}+sgx{x.y.z}`, where:
21+
- `v{x.y.z}` is the version of crates-sgx
22+
- `sgx{x.y.z}` is the version of Teaclave SGX SDK

0 commit comments

Comments
 (0)