@@ -62,7 +62,7 @@ Copy all `.el` files in this repository to `~/.emacs.d/lisp` and add the followi
6262 (setq sideline-backends-right '(chatgpt-sideline)))
6363```
6464
65- ## Contribute
65+ ## 🛠️ Contribute
6666
6767[ ![ PRs Welcome] ( https://img.shields.io/badge/PRs-welcome-brightgreen.svg )] ( http://makeapullrequest.com )
6868[ ![ Elisp styleguide] ( https://img.shields.io/badge/elisp-style%20guide-purple )] ( https://github.com/bbatsov/emacs-lisp-style-guide )
@@ -74,5 +74,64 @@ clone and make pull requests to this repository. Or you can
7474clone the project and establish your own branch of this tool.
7575Any methods are welcome!
7676
77+ ### 🔬 Development
78+
79+ To run the test locally, you will need the following tools:
80+
81+ - [ Eask] ( https://emacs-eask.github.io/ )
82+ - [ Make] ( https://www.gnu.org/software/make/ ) (optional)
83+
84+ Install all dependencies and development dependencies:
85+
86+ ``` sh
87+ $ eask install-deps --dev
88+ ```
89+
90+ To test the package's installation:
91+
92+ ``` sh
93+ $ eask package
94+ $ eask install
95+ ```
96+
97+ To test compilation:
98+
99+ ``` sh
100+ $ eask compile
101+ ```
102+
103+ ** 🪧 The following steps are optional, but we recommend you follow these lint results!**
104+
105+ The built-in ` checkdoc ` linter:
106+
107+ ``` sh
108+ $ eask lint checkdoc
109+ ```
110+
111+ The standard ` package ` linter:
112+
113+ ``` sh
114+ $ eask lint package
115+ ```
116+
117+ * 📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/ .*
118+
119+ ## ⚜️ License
120+
121+ This program is free software; you can redistribute it and/or modify
122+ it under the terms of the GNU General Public License as published by
123+ the Free Software Foundation, either version 3 of the License, or
124+ (at your option) any later version.
125+
126+ This program is distributed in the hope that it will be useful,
127+ but WITHOUT ANY WARRANTY; without even the implied warranty of
128+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
129+ GNU General Public License for more details.
130+
131+ You should have received a copy of the GNU General Public License
132+ along with this program. If not, see < https://www.gnu.org/licenses/ > .
133+
134+ See [ ` LICENSE ` ] ( ./LICENSE.txt ) for details.
135+
77136
78137[ chatgpt ] : https://github.com/emacs-openai/chatgpt
0 commit comments