Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mux Logo

mux-context

The cross-repo knowledge hub for Mux

License Docs Sonar Quality Gate

This repo is the one place that owns facts spanning more than one code repo: how the repos fit together, the language's design rationale, a feature-to-module map, shared terminology, and the release process.

It holds no build-consumed artifacts - things a build step reads (the canonical syntax spec, generated grammars, rustdoc) stay in the repo whose tooling needs them, and are linked from here. The rule: if a build step reads it, this repo does not own it.

Agents: see llms.txt for a flat, link-per-line index of everything here.


Start here

  • Architecture - the org/repo map and how the pieces connect.
  • Glossary - terminology used across the project.
  • Feature map - language/stdlib features to the modules that implement them.
  • Release process - how each repo is versioned and shipped.
  • Repo governance - labels, issue templates, and project board rules.
  • Design notes - why the compiler and runtime work the way they do.
  • Decisions - architecture decision records.

Canonical facts

These are the source of truth other READMEs copy from.

  • Name: Mux (fully "MuxLang").
  • Tagline: The programming language for everyone.
  • One-liner: Mux is a statically-typed, reference-counted language that combines Python's readability, Go's simplicity, and Rust's type safety, compiled to native code via LLVM.
  • Website & docs: mux-lang.dev
  • Install: curl -fsSL https://raw.githubusercontent.com/muxlang/mux-compiler/main/scripts/install.sh | sh
  • License: MIT.

Filing issues

Not sure which repo a bug or idea belongs to? Open it in this repo - issues filed here are triaged and moved to the right repo. If an issue is clearly scoped to one repo (e.g. a compiler crash, a website typo), file it there directly.


Repositories

Repo What it is
mux-compiler The compiler + CLI (lexer, parser, semantics, LLVM codegen). The canonical "Mux version".
mux-runtime Runtime + standard library for compiled programs. Plain stable Rust, no LLVM. Consumed by the compiler as a git dependency pinned by Cargo.lock.
mux-website The documentation site (mux-lang.dev) + the docs AI assistant + indexing tools.
mux-website-api The Fly.io compile/run API behind the playground.
tree-sitter-mux Tree-sitter grammar + highlight queries (Neovim, Helix, Emacs).
mux-syntax-highlighting TextMate grammar, VSCode extension, editor configs, and the canonical syntax spec.
.github Org profile + shared community-health files (contributing, code of conduct, issue/PR templates).

License

MIT - Maintained by Derek Corniello. Contributions welcome.

About

Cross-repo knowledge hub for the Mux language: architecture, design rationale, feature map, glossary, and release process.

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

Packages

Contributors