Skip to content

Commit 8353fc3

Browse files
committed
[update] readme to inlude crates.io installation steps.
1 parent 68a0cbf commit 8353fc3

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,25 @@ on implementing a Rust native UI framework built on top of our rendering engine.
4747
## Documentation <a name="documentation"></a>
4848
Documentation to be added soon.
4949

50-
## Building <a name="building"></a>
50+
## Installation <a name="building"></a>
51+
52+
### From crates.io
53+
lambda is now available on [crates.io](https://crates.io/crates/lambda-rs)
54+
and can be added to your project by adding the following to your
55+
`Cargo.toml` file:
56+
57+
```toml
58+
[dependencies]
59+
lambda-rs = "2023.1.28"
60+
```
61+
62+
or from the CLI:
63+
```bash
64+
cargo add lambda-rs
65+
```
66+
5167

5268
### From source <a name="source"></a>
53-
Currently, building from source is the only method to obtain a copy of Lambda.
5469

5570
#### Required external dependencies <a name="ext_deps"></a>
5671
* All platforms
@@ -106,6 +121,11 @@ An example of using shaders with push constants to render a 3D image.
106121
cargo run --example push_constants
107122
```
108123

124+
#### Notes
125+
* On windows, you need to run this example with
126+
`--features lambda-rs/with-vulkan` as the shader used in the example does not work
127+
in either dx11 or dx12.
128+
109129
### Triangle
110130
An example using shaders to render a single triangle.
111131
```rust

0 commit comments

Comments
 (0)