This repository was archived by the owner on Nov 26, 2025. It is now read-only.
File tree Expand file tree Collapse file tree 1 file changed +34
-8
lines changed
Expand file tree Collapse file tree 1 file changed +34
-8
lines changed Original file line number Diff line number Diff line change @@ -36,20 +36,46 @@ Then add the following to your `.emacs` file:
3636
3737[ ![ CI] ( https://github.com/ziglang/zig-mode/actions/workflows/main.yml/badge.svg )] ( https://github.com/ziglang/zig-mode/actions/workflows/main.yml )
3838
39- To run all unit tests with ` emacs ` , run :
39+ To run the test locally, you will need the following tools :
4040
41- ``` bash
42- ./run_tests.sh
41+ - [ Eask] ( https://emacs-eask.github.io/ )
42+ - [ Make] ( https://www.gnu.org/software/make/ ) (optional)
43+
44+ Install all dependencies and development dependencies:
45+
46+ ``` sh
47+ $ eask install-deps --dev
4348```
4449
45- Note that Emacs 26.1 or later is required. If you need to specify which Emacs
46- binary to use, you can do that by setting the ` EMACS ` environment variable,
47- e.g.:
50+ To test the package's installation:
4851
49- ``` bash
50- EMACS=/usr/bin/emacs24 ./run_tests.sh
52+ ``` sh
53+ $ eask package
54+ $ eask install
5155```
5256
57+ To test compilation:
58+
59+ ``` sh
60+ $ eask compile
61+ ```
62+
63+ ** 🪧 The following steps are optional, but we recommend you follow these lint results!**
64+
65+ The built-in ` checkdoc ` linter:
66+
67+ ``` sh
68+ $ eask lint checkdoc
69+ ```
70+
71+ The standard ` package ` linter:
72+
73+ ``` sh
74+ $ eask lint package
75+ ```
76+
77+ * 📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/ .*
78+
5379## Optional Configuration
5480
5581` zig-mode ` used to enable coloration of the compilation buffer using
You can’t perform that action at this time.
0 commit comments