[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/zig-mode 324ee9d07d 22/24: docs: Update the tests instruct
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/zig-mode 324ee9d07d 22/24: docs: Update the tests instruction |
Date: |
Wed, 21 Feb 2024 07:01:42 -0500 (EST) |
branch: elpa/zig-mode
commit 324ee9d07da482f4fd148bc60ea7876373169eb7
Author: JenChieh <jcs090218@gmail.com>
Commit: JenChieh <jcs090218@gmail.com>
docs: Update the tests instruction
---
README.md | 42 ++++++++++++++++++++++++++++++++++--------
1 file changed, 34 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 70119ba2ed..e1e77d6dc0 100644
--- a/README.md
+++ b/README.md
@@ -36,20 +36,46 @@ Then add the following to your `.emacs` file:
[![CI](https://github.com/ziglang/zig-mode/actions/workflows/main.yml/badge.svg)](https://github.com/ziglang/zig-mode/actions/workflows/main.yml)
-To run all unit tests with `emacs`, run:
+To run the test locally, you will need the following tools:
-```bash
-./run_tests.sh
+- [Eask](https://emacs-eask.github.io/)
+- [Make](https://www.gnu.org/software/make/) (optional)
+
+Install all dependencies and development dependencies:
+
+```sh
+$ eask install-deps --dev
```
-Note that Emacs 26.1 or later is required. If you need to specify which Emacs
-binary to use, you can do that by setting the `EMACS` environment variable,
-e.g.:
+To test the package's installation:
-```bash
-EMACS=/usr/bin/emacs24 ./run_tests.sh
+```sh
+$ eask package
+$ eask install
```
+To test compilation:
+
+```sh
+$ eask compile
+```
+
+**🪧 The following steps are optional, but we recommend you follow these lint
results!**
+
+The built-in `checkdoc` linter:
+
+```sh
+$ eask lint checkdoc
+```
+
+The standard `package` linter:
+
+```sh
+$ eask lint package
+```
+
+*📝 P.S. For more information, find the Eask manual at
https://emacs-eask.github.io/.*
+
## Optional Configuration
`zig-mode` used to enable coloration of the compilation buffer using
- [nongnu] elpa/zig-mode df4ecc9783 15/24: ci: Resolve CI warnings, (continued)
- [nongnu] elpa/zig-mode df4ecc9783 15/24: ci: Resolve CI warnings, ELPA Syncer, 2024/02/21
- [nongnu] elpa/zig-mode 6a0fa784b6 19/24: test: Move test to test dir, ELPA Syncer, 2024/02/21
- [nongnu] elpa/zig-mode 7f7a67de90 18/24: fix: Symbol as function name, ELPA Syncer, 2024/02/21
- [nongnu] elpa/zig-mode 66a88bffb1 21/24: ci: Test ert, ELPA Syncer, 2024/02/21
- [nongnu] elpa/zig-mode c6b89c2cfe 14/24: Add dep bot, ELPA Syncer, 2024/02/21
- [nongnu] elpa/zig-mode 6979d8d7ce 20/24: chore: Required version is now 26.1, ELPA Syncer, 2024/02/21
- [nongnu] elpa/zig-mode 3c432668b5 17/24: fix: No trailing brackets, ELPA Syncer, 2024/02/21
- [nongnu] elpa/zig-mode 2f5084f176 16/24: fix: Mix used of spaces and tabs, ELPA Syncer, 2024/02/21
- [nongnu] elpa/zig-mode 9ce2009710 24/24: Merge pull request #87 from theothornhill/master, ELPA Syncer, 2024/02/21
- [nongnu] elpa/zig-mode 5d58b22dcb 23/24: Merge branch 'master' into master, ELPA Syncer, 2024/02/21
- [nongnu] elpa/zig-mode 324ee9d07d 22/24: docs: Update the tests instruction,
ELPA Syncer <=