@@ -8,32 +8,25 @@ The latest unreleased SDK build can be found in [aws-sdk-rust/next](https://gith
**All internal and external interfaces are considered unstable and subject to change without notice.**
## Setup
Setup
-----
1.`./gradlew` will setup gradle for you. JDK 11 is required.
2. Running tests requires a working Rust installation. See [Rust docs](https://www.rust-lang.org/learn/get-started) for
installation instructions on your platform. Minimum supported Rust version is the latest released Rust version, although older versions may work.
## Generate an AWS SDK
The generated SDK will be placed in `aws/sdk/build/aws-sdk`.
```
./gradlew :aws:sdk:assemble # Generate an SDK. Do not attempt to compile / run tests
./gradlew :aws:sdk:test # Run all the tests
./gradlew :aws:sdk:cargoCheck # only validate that it compiles
```
## Run tests
```./test.sh```
Development
-----------
This will run all the unit tests, codegen example models & Dynamo DB, validate that the generated code compiles, and run any tests targeting the generated code.
## Development
For development, pre-commit hooks may be useful. Setup:
```
For development, pre-commit hooks make it easier to pass automated linting when opening a pull request. Setup:
```bash
brew install pre-commit # (or appropriate for your platform: https://pre-commit.com/)