Skip to content

Commit 13d2be5

Browse files
authored
Update README.md
1 parent 220269b commit 13d2be5

File tree

1 file changed

+60
-1
lines changed

1 file changed

+60
-1
lines changed

README.md

+60-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
Or just do `M-x vc-refresh-mode`!
1717

18-
## Contribute
18+
## 🔧 Contribute
1919

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

0 commit comments

Comments
 (0)