Skip to content

Commit 95afbca

Browse files
committed
[add] readmes for all of the packages.
1 parent 98fbc88 commit 95afbca

File tree

5 files changed

+46
-5
lines changed

5 files changed

+46
-5
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
3. [Building](#building)
1313
1. [From source](#source)
1414
1. [External dependencies](#ext_deps)
15-
2. [Optional depedencies](#opt_deps)
15+
2. [Optional dependencies](#opt_deps)
1616
3. [Linux, Macos, Windows](#bash)
1717
5. [Getting started](#get_started)
1818
6. [Examples](#examples)
@@ -64,7 +64,6 @@ or from the CLI:
6464
cargo add lambda-rs
6565
```
6666

67-
6867
### From source <a name="source"></a>
6968

7069
#### Required external dependencies <a name="ext_deps"></a>

crates/lambda-rs-args/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# lambda-rs-args
2+
Argument parsing for lambda-rs applications.
3+
4+
## Getting started
5+
TODO

crates/lambda-rs-platform/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# lambda-rs-platform
2+
Platform implementations for lambda-rs. This crate is not intended to be used directly and guarantees no stability across versions.
3+
4+
## Platforms
5+
The following platforms are currently supported:
6+
* Windows
7+
* Vulkan
8+
* DirectX 11
9+
* DirectX 12
10+
* Linux
11+
* Vulkan
12+
* OpenGL
13+
* MacOS
14+
* Metal
15+
* Vulkan

crates/lambda-rs/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# lambda-rs
2+
The lambda-rs crate provides a safe, cross-platform API for building applications on the Lambda platform.
3+
4+
## Getting started
5+
### First window
6+
Getting started with lambda is easy. The following example will create a window with the title "Hello lambda!" and a size of 800x600.
7+
```rust
8+
#[macro_use]
9+
use lambda::{
10+
core::runtime::start_runtime,
11+
runtimes::ApplicationRuntimeBuilder,
12+
};
13+
14+
fn main() {
15+
let runtime = ApplicationRuntimeBuilder::new("Hello lambda!")
16+
.with_window_configured_as(move |window_builder| {
17+
return window_builder
18+
.with_dimensions(800, 600)
19+
.with_name("Hello lambda!");
20+
})
21+
.build();
22+
23+
start_runtime(runtime);
24+
}
25+
```

crates/lambda-rs/examples/minimal.rs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,6 @@ use lambda::{
1111

1212
fn main() {
1313
let runtime = ApplicationRuntimeBuilder::new("Minimal Demo application")
14-
.with_renderer_configured_as(move |render_context_builder| {
15-
return render_context_builder.with_render_timeout(1_000_000_000);
16-
})
1714
.with_window_configured_as(move |window_builder| {
1815
return window_builder
1916
.with_dimensions(800, 600)

0 commit comments

Comments
 (0)