emacs-elpa-diffs
[Top][All Lists]
Advanced

[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



reply via email to

[Prev in Thread] Current Thread [Next in Thread]