Browse Source

Add alias tip to the readme

pull/19/head
Fredrik Ekre 1 year ago
parent
commit
143dc62200
No known key found for this signature in database
GPG Key ID: DE82E6D5E364C0A2
  1. 4
      README.md

4
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 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: 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] > [!NOTE]
> The `-m` command line flag is only available in Julia 1.12 and later. In earlier versions > 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: > you have to invoke the `main` function explicitly, for example:

Loading…
Cancel
Save