Skip to content
This repository was archived by the owner on Nov 26, 2025. It is now read-only.

Commit 24f228c

Browse files
Update README with new install instructions and new CI badge
1 parent 1a4446a commit 24f228c

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# zig-mode
22

3-
Syntax highlighting and automatic indentation for the
4-
[Zig programming language](http://ziglang.org) in Emacs. Requires Emacs 24.3 or
5-
later.
3+
Syntax highlighting and automatic indentation for the [Zig programming
4+
language](http://ziglang.org) in Emacs. Requires Emacs 24.3 or later.
65

76
## Installation
87

@@ -12,8 +11,19 @@ later.
1211
Simply install the `zig-mode` package via [NonGNU ELPA](https://elpa.nongnu.org/) or
1312
[MELPA](https://melpa.org/#/getting-started).
1413

14+
### Manual install
15+
1516
Alternatively, you can `git clone` the `zig-mode` repository somewhere
16-
(e.g. under your `~/.emacs.d/`), then add the following to your `.emacs` file:
17+
(e.g. under your `~/.emacs.d/`). `zig-mode` depends on
18+
[reformatter](https://github.com/purcell/emacs-reformatter) for
19+
formatting buffers with `zig fmt`.
20+
21+
`reformatter` can be installed from MELPA or installed manually in a
22+
similar fashion to `zig-mode`. For this method, clone the
23+
`reformatter` git repository and add the path to the repository to
24+
your `load-path`.
25+
26+
Then add the following to your `.emacs` file:
1727

1828
```elisp
1929
(unless (version< emacs-version "24")
@@ -24,7 +34,7 @@ Alternatively, you can `git clone` the `zig-mode` repository somewhere
2434

2535
## Testing
2636

27-
[![Build status](https://ci.appveyor.com/api/projects/status/u78j130vv4l6v21t?svg=true)](https://ci.appveyor.com/project/mdsteele/zig-mode)
37+
[![CI](https://github.com/ziglang/zig-mode/actions/workflows/main.yml/badge.svg)](https://github.com/ziglang/zig-mode/actions/workflows/main.yml)
2838

2939
To run all unit tests with `emacs`, run:
3040

0 commit comments

Comments
 (0)