Files
ozzy ddbddb4036 docs(readme): update readme
another readme change
fixed a formatting issue
added another item to the list of features
2026-09-27 15:34:37 -05:00

1.1 KiB

mcl

a math command line.

features

currently supports:

  • lossy/non-exact math (will not store fractions)
  • basic math functions (e.g. sqrt, normal + inverse trig functions, abs)
  • a couple basic math constants (e.g. pi, e)
  • variables (currently do basically nothing)

planned features:

  • exact math (radicals, fractions, etc.)
  • solving equations
  • a custom math language
    • scripting support
    • user defined functions

will most of these features ever actually be added? probably not. but wishful thinking is important!

usage

you can evaluate math in a couple ways while getting the result automatically:

$ mcl eval "1 + 1"
$ echo "1 + 1" | mcl

you can also use the repl to evaluate math:

$ mcl
> 1 + 1
2

for full usage, see mcl -h

installation

install using cargo.

cargo install --git https://git.ozzy.top/ozzy/mcl

building

build using just. see available recipes by running just or just --list.

contribution

before contributing, make sure all tests pass. also make sure to add tests for any new features.

just test