@ -25,6 +25,7 @@ that is appreciated by most Go programmers, see for example the following
@@ -25,6 +25,7 @@ that is appreciated by most Go programmers, see for example the following
Assuming `~/.local/bin` is in your `PATH` you can now invoke `runic`, e.g.:
@ -267,9 +271,28 @@ This assumes that Runic is installed in the `@runic` shared project as suggested
@@ -267,9 +271,28 @@ This assumes that Runic is installed in the `@runic` shared project as suggested
(push '(julia-mode . runic) apheleia-mode-alist)
```
### Git integration
The [`git-runic`](https://github.com/fredrikekre/Runic.jl/blob/master/bin/git-runic)
Here is a checklist for adopting Runic formatting in a project:
Here is a checklist for adopting Runic formatting wholesale in a project:
- Format all existing files with `runic -i <path>` and commit the changes in separate
commit. This commit can be ignored in `git blame` (see [Ignore formatting commits in git
@ -278,6 +301,9 @@ Here is a checklist for adopting Runic formatting in a project:
@@ -278,6 +301,9 @@ Here is a checklist for adopting Runic formatting in a project:
future changes adhere to the formatting rules.
- Optionally add a badge to the repository README, see [Badge](#badge).
Alternatively Runic formatting can be adopted incrementally by using the
`git-runic` integration, see [Git integration](#git-integration) for details.
#### Ignore formatting commits in git blame
When setting up Runic formatting for a repository for the first time (or when upgrading to a