Improve README.md
authorMartin Lambers <marlam@marlam.de>
Fri, 8 Jun 2018 14:07:00 +0000 (16:07 +0200)
committerMartin Lambers <marlam@marlam.de>
Fri, 8 Jun 2018 14:07:00 +0000 (16:07 +0200)
README.md

index de59ce6..c427e8b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -12,20 +12,20 @@ The evaluation of expressions is handled by the [muParser]
 (http://muparser.beltoforion.de/) math parser library.
 
 Available constants:
-  pi, e
+- `pi`, `e`
  
 Available functions:
-  deg, rad,
-  sin, asin, cos, acos, tan, atan, atan2,
-  sinh, asinh, cosh, acosh, tanh, atanh,
-  pow, exp, exp2, exp10, log, ln, log2, log10, sqrt, cbrt,
-  abs, sign, fract, int, ceil, floor, round, rint, trunc, mod,
-  min, max, sum, avg, med,
-  clamp, step, smoothstep, mix
-  random, srand48, drand48
+- `deg`, `rad`,
+- `sin`, `asin`, `cos`, `acos`, `tan`, `atan`, `atan2`,
+- `sinh`, `asinh`, `cosh`, `acosh`, `tanh`, `atanh`,
+- `pow`, `exp`, `exp2`, `exp10`, `log`, `ln`, `log2`, `log10`, `sqrt`, `cbrt`,
+- `abs`, `sign`, `fract`, `int`, `ceil`, `floor`, `round`, `rint`, `trunc`, `mod`,
+- `min`, `max`, `sum`, `avg`, `med`,
+- `clamp`, `step`, `smoothstep`, `mix`,
+- `random`, `srand48`, `drand48`
 
 Available operators:
-  ^, *, /, +, -, ==, !=, <, >, <=, >=, ||, &&, ?:
+- `^`, `*`, `/`, `+`, `-`, `==`, `!=`, `<`, `>`, `<=`, `>=`, `||`, `&&`, `?:`
 
 Other features:
   Support for variables without explicit declaration
@@ -33,13 +33,22 @@ Other features:
   Tab-completion for functions, constants, and variables
 
 Example:
-  > sin(pi/2)
-  1
-  > sin(rad(90))
-  1
-  > a = 2^3 + 2
-  10
-  > b = sqrt(49) * 2 + 6
-  20
-  > sin(2 * pi) + a * b / log10(a^(b/4)) + cos(rad(12*(a+b))) + sign(a)
-  42
+  `> sin(pi/2)`
+
+  `1`
+  
+  `> sin(rad(90))`
+  
+  `1`
+  
+  `> a = 2^3 + 2`
+  
+  `10`
+  
+  `> b = sqrt(49) * 2 + 6`
+  
+  `20`
+  
+  `> sin(2 * pi) + a * b / log10(a^(b/4)) + cos(rad(12*(a+b))) + sign(a)`
+  
+  `42`