Readme and branding

2026-05-04 22:33:48 +02:00
parent 698a3f7622
commit 528b07e54a
4 changed files with 51 additions and 2 deletions
@@ -1,2 +1,38 @@
-# mist
-The mist compiler
+# Mist Language: <br/> A C++ inspired langauge in the Rust ecosystem
+
+<!--
+Originally this readme was part of the Carbon Language project, licensed with Apache-2.0
+-->
+
+<!-- <p align="center">
+  <a href="#why-build-carbon">Why?</a> |
+  <a href="#language-goals">Goals</a> |
+  <a href="#project-status">Status</a> |
+  <a href="#getting-started">Getting started</a> |
+  <a href="#join-us">Join us</a>
+</p> -->
+
+
+<img src="code.png" align="right" width="575" alt="">
+
+<!--
+Don't let the text wrap too narrowly to the left of the above image.
+The `div` reduces the vertical height. The `picture` prevents autolinking.
+-->
+<div><picture><img src="docs/images/bumper.png" alt=""></picture></div>
+
+**Fast and works with Rust**
+
+- All of your favourite Rust libraries work with Mist
+- Compiles directly into efficient Rust code
+- Zero-cost abstractions, no runtime overhead
+
+**Ergonomic development experience**
+- C/C++ style syntax for quick onboarding
+- Minimal friction compared to raw Rust
+- Designed for fast, readable systems code
+
+**Class and type system**
+- class is syntactic sugar for a Rust struct
+- `struct B extends A` provides inheritance-style syntax over struct composition
+- Classes and structs compile into the same underlying Rust type system model
@@ -0,0 +1,13 @@
+<svg width="344" height="344" viewBox="0 0 344 344" fill="none" xmlns="http://www.w3.org/2000/svg">
+<g clip-path="url(#clip0_3_2)">
+<path d="M321.107 258.262C323.508 254.103 325 249.417 325 245.209V99.14C325 94.932 323.51 90.247 321.108 86.088L172 172.175L321.107 258.262Z" fill="#C44116"/>
+<path d="M185.25 341.193L311.75 268.159C315.394 266.055 318.706 262.422 321.107 258.262L172 172.175L22.8931 258.263C25.2941 262.422 28.6071 266.056 32.2501 268.159L158.75 341.193C166.037 345.401 177.963 345.401 185.25 341.193Z" fill="#8C2F0D"/>
+<path d="M321.108 86.087C318.706 81.927 315.393 78.294 311.75 76.19L185.25 3.156C177.963 -1.052 166.037 -1.052 158.75 3.156L32.25 76.19C24.962 80.397 19 90.725 19 99.14V245.209C19 249.417 20.491 254.103 22.893 258.262L172 172.175L321.108 86.087Z" fill="#D25228"/>
+<path d="M100 238V106H107.5L175 186.5L237 106H244.5V238" stroke="white" stroke-width="43"/>
+</g>
+<defs>
+<clipPath id="clip0_3_2">
+<rect width="344" height="344" fill="white"/>
+</clipPath>
+</defs>
+</svg>