Skip to content

Commit dbea5ac

Browse files
authored
Update Readme (#31)
- add usage instructions - add developer guidelines - edit usage links --------- Signed-off-by: Sam Spycher <[email protected]>
1 parent 5d8a309 commit dbea5ac

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,18 @@ Check out this repo's submodules:
6262
git submodule update --init --recursive
6363
```
6464

65-
You can use `act` to run the github action locally. On OSX, you need to set the container architecture, and for testcontainers to work, you may need to set the env var `TESTCONTAINERS_HOST_OVERRIDE`.
65+
Develop with Maven in the usual way, but use the `./mvnw` wrapper.
6666

67-
Example CLI input:
67+
Examples:
68+
69+
- Full build: `./mvnw clean verify`
70+
- Run all tests: `./mvnw clean test`
71+
- Run single test: `./mvnw test -pl parsec-jca-java-test -Dtest=org.parallaxsecond.parsec.jce.provider.SecureRandomParsecTest`
72+
Note: if you have container changes, clean out docker images and prefix your test run with `./mvnw install -pl parsec-testcontainers -am -Ddocker.nocache=true -Dtestcontainers.reuse.enable=false`
73+
74+
You can also use `act` to run the github action locally. On OSX, you need to set the container architecture, and for testcontainers to work, you may need to set the env var `TESTCONTAINERS_HOST_OVERRIDE`.
75+
76+
Example:
6877

6978
```sh
7079
act --container-architecture linux/amd64 --env TESTCONTAINERS_HOST_OVERRIDE=`ipconfig getifaddr en0`
@@ -75,8 +84,9 @@ act --container-architecture linux/amd64 --env TESTCONTAINERS_HOST_OVERRIDE=`ipc
7584
There are a number of example implementations of both the basic java client and JCA provider along with a demo (separate repository)
7685
Both the tests and workshop demo cover the basic functionality of the current implementation:
7786

78-
- Parsec JCA Tests [**Link**](/parsec-jca-test)
79-
- Parsec Test Containers [**Link**](/parsec-testcontainers)
87+
- Parsec JCA Tests [**Link**](/parsec-jca-java-test/src/test/java/org/parallaxsecond/parsec/jce/provider/)
88+
- Parsec Client Tests [**Link**](/parsec-client-java/src/test/java/org/parallaxsecond/parsec/client/core/)
89+
- AWS Greengrass Parsec Provider [**Link**](https://github.com/awslabs/aws-greengrass-labs-parsec-provider)
8090
- Parsec Workshop Demos (External Repository) [**Link**](https://github.com/56kcloud/parsec-workshop)
8191

8292
## License

0 commit comments

Comments
 (0)