kalker/README.md

kalk

Kalk is a calculator (both program and library) that supports user-defined variables and functions.
Project kanban board (Kolan)

Features

• Operators: +, -, *, /, !
• Groups: (), ⌈⌉, ⌋⌊
• Pre-defined functions and constants
• User-defined functions and variables. f(x, y) = xy, x = 5
• Understands fairly ambiguous syntax. Eg. 2sin50 + 2xy
• Syntax highlighting
• Special-symbol completion on tab. Eg. write sqrt and press tab. It will be turned into √.
• Sum function: sum(start, to, expression) Eg. sum(1, 3, 2n+1) is the same as 2*1+1 + 2*2+1 + 2*3+1 = 15
• Load a file including predefined functions and constants. For example, if you're going to use Kalk for physics, you load up your file with physics functions/constants when starting Kalk. -i file

Installing

Make sure you have diffutils gcc make and m4 installed. If you use windows: follow the instructions here
If anyone knows how to get gmp_mpfr_sys on Windows on Travis, let me know.

Cargo install

Run cargo install kalk_cli

Compiling yourself

1. Go into the kalk_cli directory.
2. Run cargo build --release
3. Grab the binary from targets/release