Merge pull request #51 from lambda-sh/vmarcella/runtime-upgrades

Runtime updates

Author: vmarcella

Cargo.lock

@@ -1,24 +1,25 @@
 <p align="center" style="text-align:center;">
-<img src="https://media.githubusercontent.com/media/lambda-sh/lambda/main/lambda/assets/logos/lambda_header.png" />
+<img src="https://media.githubusercontent.com/media/lambda-sh/lambda/main/crates/lambda-rs/assets/logos/lambda_header.png" />
 </p>
 
 [![Cross Platform builds & tests](https://github.com/lambda-sh/lambda/actions/workflows/compile_lambda_rs.yml/badge.svg)](https://github.com/lambda-sh/lambda/actions/workflows/compile_lambda_rs.yml)
-
-
+![lambda-rs](https://img.shields.io/crates/d/lambda-rs)
+![lambda-rs](https://img.shields.io/crates/v/lambda-rs)
 
 ## Table of contents
 1. [Description](#description)
-2. [API Documentation](#documentation)
-3. [Building](#building)
+1. [API Documentation](#documentation)
+1. [Building](#building)
+    1. [From crates.io](#crates)
     1. [From source](#source)
         1. [External dependencies](#ext_deps)
-        2. [Optional depedencies](#opt_deps)
-        3. [Linux, Macos, Windows](#bash)
-5. [Getting started](#get_started)
-6. [Examples](#examples)
-7. [Planned additions](#plans)
-8. [How to contribute](#contribute)
-9. [Resources](#resources)
+        1. [Optional dependencies](#opt_deps)
+        1. [Linux, Macos, Windows](#bash)
+1. [Getting started](#get_started)
+1. [Examples](#examples)
+1. [Planned additions](#plans)
+1. [How to contribute](#contribute)
+1. [Resources](#resources)
 ## Description <a name="description"></a>
 Lambda is a framework for developing cross platform applications and workloads using Rust.
 
@@ -45,12 +46,26 @@ lightweight HTML/CSS based rendering in the future but we're primarily focused
 on implementing a Rust native UI framework built on top of our rendering engine.
 
 ## Documentation <a name="documentation"></a>
-Documentation to be added soon.
+* [lambda-rs API documentation](https://docs.rs/lambda-rs/2023.1.29/lambda/)
+
+## Installation <a name="building"></a>
 
-## Building <a name="building"></a>
+### From crates.io <a name="crates"></a>
+lambda is now available on [crates.io](https://crates.io/crates/lambda-rs)
+and can be added to your project by adding the following to your
+`Cargo.toml` file:
+
+```toml
+[dependencies]
+lambda-rs = "2023.1.29"
+```
+
+or from the CLI:
+```bash
+cargo add lambda-rs
+```
 
 ### From source <a name="source"></a>
-Currently, building from source is the only method to obtain a copy of Lambda.
 
 #### Required external dependencies <a name="ext_deps"></a>
 * All platforms
@@ -106,6 +121,11 @@ An example of using shaders with push constants to render a 3D image.
 cargo run --example push_constants
 ```
 
+#### Notes
+* On windows, you need to run this example with
+`--features lambda-rs/with-vulkan` as the shader used in the example does not work
+in either dx11 or dx12.
+
 ### Triangle
 An example using shaders to render a single triangle.
 ```rust
@@ -135,11 +155,10 @@ cargo run --example triangles
 	- [x] Metal
 	- [x] DirectX11
 	- [x] DirectX12
-- ### Crates
-  - [x] (WIP) lambda-args -- Command line argument parsing.
-  - [x] (WIP) lambda-platform -- Dependency wrappers & platform support.
-  - [ ] lambda-cloud -- Cloud integrations.
-  - [x] (WIP) lambda -- The public Lambda API.
+- ### Packages
+  - [x] (WIP) [lambda-rs-args](./crates/lambda-rs-args/README.md) -- Command line argument parsing.
+  - [x] (WIP) [lambda-rs-platform](./crates/lambda-rs-platform/README.md) -- Dependency wrappers & platform support.
+  - [x] (WIP) [lambda-rs](./crates/lambda-rs/README.md) -- The public Lambda API.
 - ### Examples
   - [x] Minimal -- A minimal example of an application with a working window
   using lambda.

README.md

@@ -1,7 +1,7 @@
 [package]
 name = "lambda-rs-args"
 description = "Argument parser for lambda-rs tools."
-version = "2023.1.27-1"
+version = "2023.1.28"
 edition = "2021"
 license = "MIT"
 

crates/lambda-rs-args/Cargo.toml

@@ -0,0 +1,8 @@
+# lambda-rs-args
+![lambda-rs](https://img.shields.io/crates/d/lambda-rs-args)
+![lambda-rs](https://img.shields.io/crates/v/lambda-rs-args)
+
+Argument parsing for lambda-rs applications.
+
+## Getting started
+TODO

crates/lambda-rs-args/README.md

@@ -1,7 +1,7 @@
 [package]
 name = "lambda-rs-platform"
 description = "Platform implementations for lambda-rs"
-version = "2023.1.27-1"
+version = "2023.1.29"
 edition = "2021"
 resolver = "2"
 license = "MIT"

crates/lambda-rs-platform/Cargo.toml

@@ -0,0 +1,18 @@
+# lambda-rs-platform
+![lambda-rs](https://img.shields.io/crates/d/lambda-rs-platform)
+![lambda-rs](https://img.shields.io/crates/v/lambda-rs-platform)
+
+Platform implementations for lambda-rs. This crate is not intended to be used directly and guarantees no stability across versions.
+
+## Platforms
+The following platforms are currently supported:
+* Windows
+  * Vulkan
+  * DirectX 11
+  * DirectX 12
+* Linux
+  * Vulkan
+  * OpenGL
+* MacOS
+  * Metal
+  * Vulkan

crates/lambda-rs-platform/README.md

@@ -16,7 +16,7 @@ impl ShaderCompilerBuilder {
     let compiler =
       shaderc::Compiler::new().expect("Failed to create shaderc compiler.");
 
-    let mut options = shaderc::CompileOptions::new()
+    let options = shaderc::CompileOptions::new()
       .expect("Failed to create shaderc compile options.");
 
     return ShaderCompiler {

crates/lambda-rs-platform/src/shaderc/mod.rs

@@ -1,3 +1,5 @@
+//! Winit wrapper to easily construct cross platform windows
+
 use winit::{
   dpi::{
     LogicalSize,
@@ -25,6 +27,7 @@ pub mod winit_exports {
     event::{
       ElementState,
       Event,
+      MouseButton,
       VirtualKeyCode,
       WindowEvent,
     },

crates/lambda-rs-platform/src/winit/mod.rs

@@ -1,7 +1,7 @@
 [package]
 name = "lambda-rs"
 description = "A framework for building cross platform graphics & compute applications."
-version = "2023.1.27-1"
+version = "2023.1.29"
 edition = "2021"
 license = "MIT"
 keywords = ["graphics", "compute"]
@@ -12,7 +12,7 @@ name = "lambda"
 path = "src/lib.rs"
 
 [dependencies]
-lambda-rs-platform = { path = "../lambda-rs-platform", version = "2023.1.27-1"}
+lambda-rs-platform = { path = "../lambda-rs-platform", version = "2023.1.29"}
 
 [dev-dependencies]
 cargo-audit = "0.16.0"

crates/lambda-rs/Cargo.toml

@@ -0,0 +1,36 @@
+<p align="center" style="text-align:center;">
+<img src="https://media.githubusercontent.com/media/lambda-sh/lambda/main/crates/lambda-rs/assets/logos/lambda_header.png" />
+</p>
+
+![lambda-rs](https://img.shields.io/crates/d/lambda-rs)
+![lambda-rs](https://img.shields.io/crates/v/lambda-rs)
+
+The lambda-rs crate provides a safe, cross-platform API for building applications on the Lambda platform.
+
+# Installation
+```bash
+cargo add lambda-rs
+```
+
+# Getting started
+## First window
+Getting started with lambda is easy. The following example will create a window with the title "Hello lambda!" and a size of 800x600.
+```rust
+#[macro_use]
+use lambda::{
+  core::runtime::start_runtime,
+  runtimes::ApplicationRuntimeBuilder,
+};
+
+fn main() {
+  let runtime = ApplicationRuntimeBuilder::new("Hello lambda!")
+    .with_window_configured_as(move |window_builder| {
+      return window_builder
+        .with_dimensions(800, 600)
+        .with_name("Hello lambda!");
+    })
+    .build();
+
+  start_runtime(runtime);
+}
+```