diff --git a/Cargo.toml b/Cargo.toml index 72b48fa..cad2b41 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -5,3 +5,4 @@ resolver = "2" [workspace.package] version = "0.0.1" authors = ["joe ardent"] +license-file = "LICENSE.md" diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..589cfb6 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,5 @@ +# The Chaos License (GLP) + +This software is released under the terms of the Chaos License. In cases where the terms of the +license are unclear, refer to the [Fuck Around and Find Out +License](https://git.sr.ht/~boringcactus/fafol/tree/master/LICENSE-v0.2.md). diff --git a/README.md b/README.md new file mode 100644 index 0000000..2419ecd --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +Working through the [Fly.io distributed systems challenge](https://fly.io/dist-sys/), in Rust. + +The project is organized as a Cargo workspace. The `maelstrom-*` crates are libraries that provide +the equivalent functionality as the [Maelstrom +Go](https://pkg.go.dev/github.com/jepsen-io/maelstrom/demo/go) package that is provided by +Fly.io. The protocol crate especially is stand-alone and just provides the +serializable/deserializable Rust types for Maelstrom messages. The node crate handles IO, while the +`gg-*` crates are bin crates that implement the named challenge.