aboutsummaryrefslogtreecommitdiffstats
path: root/docs/guide
diff options
context:
space:
mode:
authors-ol <s+removethis@s-ol.nu>2025-08-04 22:08:41 +0000
committers-ol <s+removethis@s-ol.nu>2025-08-04 22:27:26 +0000
commit875b51ccc9e8891bd2b4d44a6c42a8e4d78f355b (patch)
tree30c2f51f7e0f85ad7f082930e39375c19c43f8b9 /docs/guide
parentdocs/reference: update comments, literals sections (diff)
downloadalive-875b51ccc9e8891bd2b4d44a6c42a8e4d78f355b.tar.gz
alive-875b51ccc9e8891bd2b4d44a6c42a8e4d78f355b.zip
docs: small fixes in guide and reference
Diffstat (limited to 'docs/guide')
-rw-r--r--docs/guide/01_installation.md4
-rw-r--r--docs/guide/04_syntax.md11
-rw-r--r--docs/guide/06_importing-operators.md6
-rw-r--r--docs/guide/07_defining-symbols.md8
4 files changed, 21 insertions, 8 deletions
diff --git a/docs/guide/01_installation.md b/docs/guide/01_installation.md
index 5a192fa..26a5e9f 100644
--- a/docs/guide/01_installation.md
+++ b/docs/guide/01_installation.md
@@ -36,6 +36,10 @@ With the `alive` package, two binaries should have been installed on your system
apply the exports from `luarocks path` upon login, e.g. in your `.bashrc`.
## windows
+
+> Windows builds are currently not being updated. Please email me if you need
+> help setting up `alv`.
+
For Windows, a binary package is available from the latest
[github release][:*release*:]. It includes not only the `alv` source code, but
also a compiled version of Lua 5.3 as well as Luarocks and all of `alv`'s
diff --git a/docs/guide/04_syntax.md b/docs/guide/04_syntax.md
index 29361f7..e4c79bc 100644
--- a/docs/guide/04_syntax.md
+++ b/docs/guide/04_syntax.md
@@ -29,12 +29,21 @@ expression simply by adding a `#` character in front.
#(this is a comment)
+ #also-a-comment
+
#(this is a long,
multi-line comment,
(and it also has nested parentheses).
It ends after this sentence.)
You can put comments anywhere in your program where whitespace is allowed and
-it will simply be ignored by `alv`.
+it will simply be ignored by `alv`. You can also comment an entire line using a
+double `##`:
+
+ (print "test") ## just a little note here
+
+ ## the next line is valid,
+ ## parenthesis ) ))) in line comments are #(just ignored.
+
[clojure-style]: https://github.com/bbatsov/clojure-style-guide
diff --git a/docs/guide/06_importing-operators.md b/docs/guide/06_importing-operators.md
index 2195d5c..4baf19b 100644
--- a/docs/guide/06_importing-operators.md
+++ b/docs/guide/06_importing-operators.md
@@ -1,10 +1,10 @@
-Apart from [trace][], there are only very little builtin operators in `alv` -
+Apart from [trace][], there are relatively little builtin operators in `alv` -
you can see all of them in the *builtins* section of the [reference][:/:].
All of the 'real' functionality of `alv` is grouped into *modules*, that have
to be loaded individually. *Modules* help organize all of the operators so that
it is less overwhelming to look for a concrete feature. It is also possible to
-create your own plugins as new modules, which will be covered in another guide
-soon.
+create your own plugins as new modules, which is covered in the internals
+section.
Let's try using the [`+` operator][:math/+:] from the [math/][] module. To use
operators from a module, we need to tell `alv` to load it first: We can load
diff --git a/docs/guide/07_defining-symbols.md b/docs/guide/07_defining-symbols.md
index 488270a..207680d 100644
--- a/docs/guide/07_defining-symbols.md
+++ b/docs/guide/07_defining-symbols.md
@@ -21,10 +21,10 @@ symbol `result`, and then refer to it by that symbol in the [trace][] operator:
Symbols need to start with a letter or one of the following special characters:
- - + * /
- _ . , =
- ! ? % $
- > < ~
+ - _ + * ^
+ % / . , =
+ ~ ! ? % $
+ > <
After the first character, numbers are also allowed. There are two types of
symbols that are treated specially: symbols containing a slash (`math/+`), and