From 59101308325f5863c4267e513634bef391ff242a Mon Sep 17 00:00:00 2001 From: Derek Corniello Date: Wed, 5 Aug 2026 20:28:39 -0700 Subject: [PATCH] updates to readmes --- README.md | 10 ++++++++++ profile/README.md | 37 +++++++++++++------------------------ 2 files changed, 23 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index f5146f3..bff36ce 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,16 @@ Policy and workflow rules: --- +## FOSS Usage: + +Thank you to the following companies who have allowed this project to use their services under FOSS terms: + +[Greptile](https://www.greptile.com): The War on Bugs [![Greptile: The War on Bugs](https://www.greptile.com/badge.svg)](https://www.greptile.com/?utm_source=oss_badge&utm_medium=readme&utm_campaign=greptile_for_open_source) + +[SonarQube Cloud](https://sonarcloud.io): Continuous Code Quality and Security ![SonarQube Cloud](https://img.shields.io/badge/-black?style=flat&logo=sonarqubecloud&logoColor=white) + +[Blacksmith](https://www.blacksmith.sh): The fastest way to run your GitHub Actions + ## License [MIT](LICENSE) - Maintained by [Derek Corniello](https://github.com/DerekCorniello) diff --git a/profile/README.md b/profile/README.md index bd0b9d5..52423c1 100644 --- a/profile/README.md +++ b/profile/README.md @@ -19,36 +19,15 @@ via LLVM. --- -## A first taste - -```mux -// Error handling with Result types -func divide(int a, int b) returns result { - if b == 0 { - return err("division by zero") - } - return ok(a / b) -} - -// Pattern matching with exhaustive checking -func main() returns void { - match divide(10, 2) { - ok(value) { - print("Result: " + value.to_string()) - } - err(error) { - print("Error: " + error) - } - } -} -``` - ## Get started ```bash # Install (Linux/macOS) curl -fsSL https://raw.githubusercontent.com/muxlang/mux-compiler/main/scripts/install.sh | sh +# Or on Windows (PowerShell) +irm https://raw.githubusercontent.com/muxlang/mux-compiler/main/scripts/install.ps1 | iex + # Run your first program mux run hello.mux ``` @@ -84,6 +63,16 @@ Or skip the install and **[try it in the playground](https://mux-lang.dev/playgr - **Found a bug or have an idea?** Open an issue in the relevant repo - or, if you're unsure which, in [mux-context](https://github.com/muxlang/mux-context/issues) for triage. +## FOSS Usage: + +Thank you to the following companies who have allowed this project to use their services under FOSS terms: + +[Greptile](https://www.greptile.com): The War on Bugs [![Greptile: The War on Bugs](https://www.greptile.com/badge.svg)](https://www.greptile.com/?utm_source=oss_badge&utm_medium=readme&utm_campaign=greptile_for_open_source) + +[SonarQube Cloud](https://sonarcloud.io): Continuous Code Quality and Security ![SonarQube Cloud](https://img.shields.io/badge/-black?style=flat&logo=sonarqubecloud&logoColor=white) + +[Blacksmith](https://www.blacksmith.sh): The fastest way to run your GitHub Actions +
Mux is MIT-licensed and welcomes contributions.