Skip to content

Commit

Permalink
add TLDR instructions to top-level README (#67)
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewmwells-amazon authored Nov 8, 2023
1 parent 12fbc53 commit 9de7bd1
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,19 @@
This repository contains the source code for a Java package `CedarJava` that supports using the [Cedar](https://www.cedarpolicy.com) policy language.
It also contains source code for a Rust crate `CedarJavaFFI` that enables calling Cedar library functions (written in Rust) from Java.

You can find build instructions and more information in the subfolders.

## Getting Started
You can find detailed build instructions and more information in the subfolders [CedarJavaFFI](https://github.com/cedar-policy/cedar-java/blob/main/CedarJavaFFI/README.md), [CedarJava](https://github.com/cedar-policy/cedar-java/blob/main/CedarJava/README.md).

For typical use, you'll want something like:

```shell
cd CedarJavaFFI && cargo build
cd ../CedarJava
export CEDAR_INTEGRATION_TESTS_ROOT=/tmp #(assuming you don't want to run them)
export CEDAR_JAVA_FFI_LIB=path_to_CedarJavaFFI/target/debug/libcedar_java_ffi.so #(or wherever you built CedarJavaFFI)
gradle test
```

## Notes

Expand Down

0 comments on commit 9de7bd1

Please sign in to comment.