Skip to content

Commit 35600ec

Browse files
authored
Update README.md
1 parent 55fe4a4 commit 35600ec

File tree

1 file changed

+62
-3
lines changed

1 file changed

+62
-3
lines changed

README.md

Lines changed: 62 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,21 @@
1010
<img src="./etc/demo.png" width="543" height="279" />
1111
</p>
1212

13-
## :floppy_disk: Quickstart
13+
## 💾 Quickstart
1414

1515
```el
1616
(use-package eldoc-meta-net
1717
:ensure t
1818
:hook (csharp-mode . (lambda () (eldoc-meta-net-enable))))
1919
```
2020

21-
## :hammer: Configurations
21+
## 🔨 Configurations
2222

2323
#### `eldoc-meta-net-display-summary`
2424

2525
Display parameter's summary under ElDoc.
2626

27-
## Contribute
27+
## 🛠️ Contribute
2828

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

0 commit comments

Comments
 (0)