Unverified Commit edb395f6 authored by Russell Cohen's avatar Russell Cohen Committed by GitHub
Browse files

Update README.md (#170) 



* Update README.md

* Update README.md

* Update README.md

Co-authored-by: default avatarKerem Kat <keremkat@gmail.com>

Co-authored-by: default avatarKerem Kat <keremkat@gmail.com>
parent 2ff12e6a

README.md

+6 −2
Original line number Diff line number Diff line 
# Smithy Rust ![status](https://github.com/awslabs/smithy-rs/workflows/CI/badge.svg)

Smithy code generators for Rust



The nightly SDK build can be found under `Actions -> CI (take latest run) -> Artifacts`



**All internal and external interfaces are considered unstable and subject to change without notice.**



## Setup

1. `./gradlew` will setup gradle for you

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.

installation instructions on your platform. Minimum supported Rust version is the latest released Rust version, although older versions may work.



## Run tests

```./tesh.sh```



This will run all the unit tests, codegen an example model end-to-end and validates that the generated code compiles.

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: