@@ -21,7 +21,7 @@ Place the following line in your config file:
2121(jcs-echobar-mode 1)
2222```
2323
24- ## Contribute
24+ ## 🛠️ Contribute
2525
2626[ ![ PRs Welcome] ( https://img.shields.io/badge/PRs-welcome-brightgreen.svg )] ( http://makeapullrequest.com )
2727[ ![ Elisp styleguide] ( https://img.shields.io/badge/elisp-style%20guide-purple )] ( https://github.com/bbatsov/emacs-lisp-style-guide )
@@ -32,3 +32,62 @@ If you would like to contribute to this project, you may either
3232clone and make pull requests to this repository. Or you can
3333clone the project and establish your own branch of this tool.
3434Any methods are welcome!
35+
36+ ### 🔬 Development
37+
38+ To run the test locally, you will need the following tools:
39+
40+ - [ Eask] ( https://emacs-eask.github.io/ )
41+ - [ Make] ( https://www.gnu.org/software/make/ ) (optional)
42+
43+ Install all dependencies and development dependencies:
44+
45+ ``` sh
46+ $ eask install-deps --dev
47+ ```
48+
49+ To test package's installation:
50+
51+ ``` sh
52+ $ eask package
53+ $ eask install
54+ ```
55+
56+ To test compilation:
57+
58+ ``` sh
59+ $ eask compile
60+ ```
61+
62+ ** 🪧 The following steps are optional, but we recommend you follow these lint results!**
63+
64+ The built-in ` checkdoc ` linter:
65+
66+ ``` sh
67+ $ eask lint checkdoc
68+ ```
69+
70+ The standard ` package ` linter:
71+
72+ ``` sh
73+ $ eask lint package
74+ ```
75+
76+ * 📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/ .*
77+
78+ ## ⚜️ License
79+
80+ This program is free software; you can redistribute it and/or modify
81+ it under the terms of the GNU General Public License as published by
82+ the Free Software Foundation, either version 3 of the License, or
83+ (at your option) any later version.
84+
85+ This program is distributed in the hope that it will be useful,
86+ but WITHOUT ANY WARRANTY; without even the implied warranty of
87+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
88+ GNU General Public License for more details.
89+
90+ You should have received a copy of the GNU General Public License
91+ along with this program. If not, see < https://www.gnu.org/licenses/ > .
92+
93+ See [ ` LICENSE ` ] ( ./LICENSE.txt ) for details.
0 commit comments