From 143dc622004cfd91cc5d1b915c22b33eaa26c454 Mon Sep 17 00:00:00 2001 From: Fredrik Ekre Date: Fri, 12 Jul 2024 20:28:07 +0200 Subject: [PATCH] Add alias tip to the readme --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index dfbf8d8..afa1d3c 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,10 @@ Pkg.add(url = "https://github.com/fredrikekre/Runic.jl") The main interface to Runic is the command line interface (CLI) through the `main` function invoked with the `-m` flag. See the output of `julia -m Runic --help` for details: +> [!TIP] +> Add `alias runic="julia -m Runic""` to your shell startup file to make the CLI easier to +> invoke. + > [!NOTE] > The `-m` command line flag is only available in Julia 1.12 and later. In earlier versions > you have to invoke the `main` function explicitly, for example: