Move README to Markdown format.
[mucalc.git] / README.md
1 # mucalc - convenient command line calculator
2
3 This calculator is intended for command line users.
4
5 It evaluates mathematical expressions that are given as arguments, read from
6 an input stream, or typed interactively.
7
8 In interactive mode, it provides line editing with tab-completion and
9 persistent history using [GNU readline](https://www.gnu.org/software/readline).
10
11 The evaluation of expressions is handled by the [muParser]
12 (http://muparser.beltoforion.de/) math parser library.
13
14 Available constants:
15   pi, e
16  
17 Available functions:
18   deg, rad,
19   sin, asin, cos, acos, tan, atan, atan2,
20   sinh, asinh, cosh, acosh, tanh, atanh,
21   pow, exp, exp2, exp10, log, ln, log2, log10, sqrt, cbrt,
22   abs, sign, fract, int, ceil, floor, round, rint, trunc, mod,
23   min, max, sum, avg, med,
24   clamp, step, smoothstep, mix
25   random, srand48, drand48
26
27 Available operators:
28   ^, *, /, +, -, ==, !=, <, >, <=, >=, ||, &&, ?:
29
30 Other features:
31   Support for variables without explicit declaration
32   Support for multiple expressions on one line, separated by commas
33   Tab-completion for functions, constants, and variables
34
35 Example:
36   > sin(pi/2)
37   1
38   > sin(rad(90))
39   1
40   > a = 2^3 + 2
41   10
42   > b = sqrt(49) * 2 + 6
43   20
44   > sin(2 * pi) + a * b / log10(a^(b/4)) + cos(rad(12*(a+b))) + sign(a)
45   42