Skip to content

Commit 91650a7

Browse files
authored
Update README.md
1 parent cfb0aa9 commit 91650a7

File tree

1 file changed

+60
-1
lines changed

1 file changed

+60
-1
lines changed

README.md

Lines changed: 60 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ tunnel. If you want to use ChatGPT, do the following:
105105
- `codegpt-max-tokens` - The maximum number of tokens to generate in the completion.
106106
- `codegpt-temperature` - What sampling temperature to use.
107107

108-
## Contribute
108+
## 🛠️ Contribute
109109

110110
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
111111
[![Elisp styleguide](https://img.shields.io/badge/elisp-style%20guide-purple)](https://github.com/bbatsov/emacs-lisp-style-guide)
@@ -116,3 +116,62 @@ If you would like to contribute to this project, you may either
116116
clone and make pull requests to this repository. Or you can
117117
clone the project and establish your own branch of this tool.
118118
Any methods are welcome!
119+
120+
### 🔬 Development
121+
122+
To run the test locally, you will need the following tools:
123+
124+
- [Eask](https://emacs-eask.github.io/)
125+
- [Make](https://www.gnu.org/software/make/) (optional)
126+
127+
Install all dependencies and development dependencies:
128+
129+
```sh
130+
$ eask install-deps --dev
131+
```
132+
133+
To test the package's installation:
134+
135+
```sh
136+
$ eask package
137+
$ eask install
138+
```
139+
140+
To test compilation:
141+
142+
```sh
143+
$ eask compile
144+
```
145+
146+
**🪧 The following steps are optional, but we recommend you follow these lint results!**
147+
148+
The built-in `checkdoc` linter:
149+
150+
```sh
151+
$ eask lint checkdoc
152+
```
153+
154+
The standard `package` linter:
155+
156+
```sh
157+
$ eask lint package
158+
```
159+
160+
*📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.*
161+
162+
## ⚜️ License
163+
164+
This program is free software; you can redistribute it and/or modify
165+
it under the terms of the GNU General Public License as published by
166+
the Free Software Foundation, either version 3 of the License, or
167+
(at your option) any later version.
168+
169+
This program is distributed in the hope that it will be useful,
170+
but WITHOUT ANY WARRANTY; without even the implied warranty of
171+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
172+
GNU General Public License for more details.
173+
174+
You should have received a copy of the GNU General Public License
175+
along with this program. If not, see <https://www.gnu.org/licenses/>.
176+
177+
See [`LICENSE`](./LICENSE.txt) for details.

0 commit comments

Comments
 (0)