Skip to content

Commit 354f4f6

Browse files
docs: update README for missing info (#1939)
1 parent 6e1e48c commit 354f4f6

File tree

2 files changed

+31
-11
lines changed

2 files changed

+31
-11
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,9 @@ This repository is a top level repository which houses all source code in order
4848
different runtimes.
4949

5050
This library is written in Dafny, a formally verifiable programming language that can be compiled into
51-
different runtimes. This library is currently **ONLY** supported in Java and .NET
51+
different runtimes. This library is currently **ONLY** supported in Java, .NET and Rust.
52+
53+
<!-- TODO: Add Go to supported languages https://sim.amazon.com/issues/CrypTool-5444 -->
5254

5355
### AWS Integration
5456

@@ -68,10 +70,11 @@ You need an Amazon Web Services (AWS) account to use the DB-ESDK for DynamoDB as
6870
- .NET
6971
- Dafny
7072
- Rust
73+
<!-- TODO: Add Go to supported languages https://sim.amazon.com/issues/CrypTool-5444 -->
7174

7275
# Contributing
7376

74-
See [CONTRIBUTING](CONTRIBUTING.md) for more information.
77+
See [CONTRIBUTING](CONTRIBUTING.md) for more information. For detailed information about code organization and development see [DynamoDbEncryption README](./DynamoDbEncryption/README.md)
7578

7679
# License
7780

TestVectors/README.md

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,32 @@ This validates the Database Encryption SDK's cross-version compatibility.
1616

1717
### Building and Running
1818

19-
1. Start in the root `./TestVectors` directory
20-
2. Run `make build_java`
21-
3. Run `make test_java`
22-
4. Run `make transpile_net`
23-
5. Run `cd runtimes/net`
24-
6. Run `dotnet run --framework net6.0`
25-
7. Run `make transpile_rust`
26-
8. Run `make polymorph_rust`
27-
9. Run `make test_rust`
19+
Start in the root `./TestVectors` directory and read the runtime specific building and running instructions below.
20+
21+
#### Java
22+
23+
1. Run `make build_java`
24+
2. Run `make test_java`
25+
26+
#### .NET
27+
28+
1. Run `make transpile_net`
29+
2. Run `cp ./runtimes/java/*.json ./runtimes/net/`
30+
3. Run `cd runtimes/net`
31+
4. Run `dotnet run --framework net6.0`
32+
33+
#### Rust
34+
35+
1. Run `make transpile_rust`
36+
2. Run `cp ./runtimes/java/*.json ./runtimes/rust/`
37+
3. Run `make polymorph_rust`
38+
4. Run `make test_rust`
39+
40+
#### Go
41+
42+
1. Run `make transpile_go`
43+
2. Run `cp ./runtimes/java/*.json ./runtimes/go/`
44+
3. Run `make test_go`
2845

2946
### Saving results for later
3047

0 commit comments

Comments
 (0)