Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #80

Closed
wants to merge 1 commit into from
Closed

Update README.md #80

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,16 +59,26 @@ alias runic="julia --project=@runic -m Runic"
```

> [!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:
> Running `Runic` in Julia 1.11 and Earlier:
> You have to invoke the `main` function explicitly, for example:
> ```sh
> julia -e 'using Runic; exit(Runic.main(ARGS))' -- <args>
> ```
> as the `-m` command line flag is only available in Julia 1.12 and later.
>
> For this incantation the following shell alias can be used:
> ```sh
> alias runic="julia --project=@runic -e 'using Runic; exit(Runic.main(ARGS))' --"
> ```

> Example usage:
> To format all julia files in the current directory inplace, just run:
> ```sh
> julia --project=@runic -e 'using Runic; exit(Runic.main(ARGS))' -- "--inplace" "./"
> ```
> or, if an alias was set up:
> ```sh
> runic --inplace ./
> ```
```
$ julia -m Runic --help
NAME
Expand Down