Skip to content

updates to readmes #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DerekCorniello merged 1 commit into from
Aug 6, 2026
Merged

updates to readmes #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
37 changes: 13 additions & 24 deletions profile/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,36 +19,15 @@ via LLVM.

---

## A first taste

```mux
// Error handling with Result types
func divide(int a, int b) returns result<int, string> {
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
```
Expand Down Expand Up @@ -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

<div align="center">

Mux is MIT-licensed and welcomes contributions.
Expand Down
Loading