From 012f1d652bf17898e218a138547a7b8a92a3769a Mon Sep 17 00:00:00 2001 From: VaclavT Date: Mon, 22 Feb 2021 23:01:17 +0100 Subject: [PATCH] doc wip --- doc/Doc.md | 83 ++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 58 insertions(+), 25 deletions(-) diff --git a/doc/Doc.md b/doc/Doc.md index 2b0eeb6..f2bef14 100644 --- a/doc/Doc.md +++ b/doc/Doc.md @@ -15,28 +15,61 @@ ## Library - -#### Using the binary - -Run ml in interactive mode: - -```bash -$ ./ml ->>> (print "Hello world!") -Hello world! - => "Hello world!" -``` - -Interpret a file: - -```bash -$ ./ml -f "examples/hello_world.lisp" -Hello world! -``` - -Interpret from command line argument: - -```bash -$ ./ml -c '(print "Hello world!")' -Hello world! -``` +|Signature|Description|Return values| +|:-|-|-| +|`(= a b)`|Test whether two values are equal|`1` when equal otherwise `0`| +|`(!= a b)`|Test whether two values are not equal|`1` when not equal otherwise `0`| +|`(> a b)`|Test whether one value is greater to another |`1` when greater otherwise `0`| +|`(< a b)`|Test whether one value is less to another |`1` when less otherwise `0`| +|`(>= a b)`|Test whether one value is greater or equal to another |`1` when greater or equal otherwise `0`| +|`(<= a b)`|Test whether one value is less or equal to another |`1` when less or equal otherwise `0`| +|`(+ a b ..)`|Sum multiple values |sum of values| +|`(- a b)`|Substract two values |result of substraction| +|`(* a b ..)`|Multiply several values|result of multiplication| +|`(/ a b)`|Divide two values|result of division| +|`(% a b)`|Remainder of division|result of operation| +|`(list ..)`|Create a list of values|| +|`(insert list index element)`|Insert an element into a lis.Indexed from 0|new list with value inserted| +|`(index list index)`|Return element at index in list|Element at index| +|`(remove list index)`|Remove a value at an index from a list|List with element removed| +|`(len list)`|Get the length of a list|list length| +|`(push list element)`|Add an item to the end of a list|new list with element added| +|`(pop ..)`||| +|`(head list)`|Returns first element of a list|First element| +|`(tail list)`|Return all elements of list except first one|List without first element| +|`(first ..)`||| +|`(last ..)`||| +|`(range ..)`||| +|`(map ..)`||| +|`(filter ..)`|`(filter (lambda (x) (> x 2)) '(1 2 3 4 5)) => (3 4 5)`|| +|`(reduce ..)`||| +|`(exit ..)`||| +|`(quit ..)`||| +|`(print ..)`||| +|`(input ..)`||| +|`(random ..)`||| +|`(include ..)`||| +|`(read-file ..)`||| +|`(write-file ..)`||| +|`(read-url ..)`||| +|`(system-cmd ..)`||| +|`(ls-dir ..)`||| +|`(is-file? ..)`||| +|`(is-dir? ..)`||| +|`(parse-csv ..)`||| +|`(parse-json ..)`||| +|`(save-csv ..)`||| +|`(get-universal-time ..)`||| +|`(date-to-str ..)`||| +|`(str-to-date ..)`||| +|`(date-add ..)`||| +|`(debug ..)`||| +|`(display ..)`||| +|`(replace ..)`||| +|`(regex-search? ..)`||| +|`(int ..)`||| +|`(float ..)`||| +|`(eval ..)`||| +|`(type ..)`||| +|`(parse ..)`||| +|`(xx ..)`|||