Skip to content

Commit d45bbbd

Browse files
authored
docs: Add contirbute
1 parent 74531a4 commit d45bbbd

File tree

1 file changed

+70
-1
lines changed

1 file changed

+70
-1
lines changed

README.md

Lines changed: 70 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,79 @@
44
# dashboard-bm
55
> Visual Bookmarks (bm.el) for Dashboard
66
7-
## Usage
7+
## 🔧 Usage
88

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

0 commit comments

Comments
 (0)