diff --git a/README.md b/README.md index f21c812..8e22bfe 100644 --- a/README.md +++ b/README.md @@ -166,7 +166,7 @@ Try `M-x openai-debug-mode`, it will show more error messages. - [aide.el](https://github.com/junjizhi/aide.el) - [ChatGPT.el](https://github.com/joshcho/ChatGPT.el) -## Contribute +## 🛠️ Contribute [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com) [![Elisp styleguide](https://img.shields.io/badge/elisp-style%20guide-purple)](https://github.com/bbatsov/emacs-lisp-style-guide) @@ -178,3 +178,62 @@ clone and make pull requests to this repository. Or you can clone the project and establish your own branch of this tool. Any methods are welcome! + +### 🔬 Development + +To run the test locally, you will need the following tools: + +- [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 +``` + +To test the package's installation: + +```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/.* + +## ⚜️ License + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + +See [`LICENSE`](./LICENSE.txt) for details.