Skip to content

docs: update README for missing info #1939

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Jun 10, 2025
Merged

docs: update README for missing info #1939

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
003561f
auto commit
rishav-karanjit Jun 9, 2025
faf7330
empty commit
rishav-karanjit Jun 9, 2025
724f30e
auto commit
rishav-karanjit Jun 9, 2025
7ca0451
auto commit
rishav-karanjit Jun 9, 2025
17aee27
auto commit
rishav-karanjit Jun 9, 2025
0e28707
auto commit
rishav-karanjit Jun 9, 2025
4680530
auto commit
rishav-karanjit Jun 9, 2025
aa3b643
Merge branch 'main' into ReadMeUpdate
rishav-karanjit Jun 9, 2025
29f3c03
auto commit
rishav-karanjit Jun 10, 2025
9fea72f
Merge branch 'main' into ReadMeUpdate
rishav-karanjit Jun 10, 2025
3560670
auto commit
rishav-karanjit Jun 10, 2025
9ac42dd
auto commit
rishav-karanjit Jun 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,9 @@ This repository is a top level repository which houses all source code in order
different runtimes.

This library is written in Dafny, a formally verifiable programming language that can be compiled into
different runtimes. This library is currently **ONLY** supported in Java and .NET
different runtimes. This library is currently **ONLY** supported in Java, .NET and Rust.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will add Go later when we get close to the release


<!-- TODO: Add Go to supported languages https://sim.amazon.com/issues/CrypTool-5444 -->

### AWS Integration

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

# Contributing

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

# License

Expand Down
35 changes: 26 additions & 9 deletions TestVectors/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,32 @@ This validates the Database Encryption SDK's cross-version compatibility.

### Building and Running

1. Start in the root `./TestVectors` directory
2. Run `make build_java`
3. Run `make test_java`
4. Run `make transpile_net`
5. Run `cd runtimes/net`
6. Run `dotnet run --framework net6.0`
7. Run `make transpile_rust`
8. Run `make polymorph_rust`
9. Run `make test_rust`
Start in the root `./TestVectors` directory and read the runtime specific building and running instructions below.

#### Java

1. Run `make build_java`
2. Run `make test_java`

#### .NET

1. Run `make transpile_net`
2. Run `cp ./runtimes/java/*.json ./runtimes/net/`
3. Run `cd runtimes/net`
4. Run `dotnet run --framework net6.0`

#### Rust

1. Run `make transpile_rust`
2. Run `cp ./runtimes/java/*.json ./runtimes/rust/`
3. Run `make polymorph_rust`
4. Run `make test_rust`

#### Go

1. Run `make transpile_go`
2. Run `cp ./runtimes/java/*.json ./runtimes/go/`
3. Run `make test_go`

### Saving results for later

Expand Down
Loading