From 29b3bed452fe0d222ac6009e8aaf0fb98cd4df94 Mon Sep 17 00:00:00 2001 From: Eduard Urbach Date: Mon, 17 Feb 2025 11:15:59 +0100 Subject: [PATCH] Updated documentation --- docs/readme.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/readme.md b/docs/readme.md index b48c67e..f130c9d 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -18,17 +18,16 @@ go build ``` This will place the compiler inside the repository. +Either use `./q` or get access to the shorter `q` in any directory with `ln -s $PWD/q ~/.local/bin/q`. -### Symlink +## Examples -Either use `./q` for the following examples or get access to the shorter `q` in any directory via symlink: +You can take a look at the [examples](examples). ```shell -ln -s $PWD/q ~/.local/bin/q +q run examples/hello ``` -This assumes that your shell loads `~/.local/bin`. - ## Usage ```