Skip to content

Commit 705fd09

Browse files
authored
Update README.md
1 parent deea4e8 commit 705fd09

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
@@ -80,7 +80,7 @@ detail in [LTEX Settings](https://valentjn.github.io/vscode-ltex/docs/settings.h
8080
* [`ltex.statusBarItem`](https://valentjn.github.io/ltex/settings.html#ltexstatusbaritem) via `lsp-ltex-status-bar-item` (currently, not implemented)
8181
* [`ltex.trace.server`](https://valentjn.github.io/ltex/settings.html#ltextraceserver) via `lsp-ltex-trace-server`
8282

83-
## Contribute
83+
## 🛠️ Contribute
8484

8585
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
8686
[![Elisp styleguide](https://img.shields.io/badge/elisp-style%20guide-purple)](https://github.com/bbatsov/emacs-lisp-style-guide)
@@ -91,3 +91,62 @@ If you would like to contribute to this project, you may either
9191
clone and make pull requests to this repository. Or you can
9292
clone the project and establish your own branch of this tool.
9393
Any methods are welcome!
94+
95+
### 🔬 Development
96+
97+
To run the test locally, you will need the following tools:
98+
99+
- [Eask](https://emacs-eask.github.io/)
100+
- [Make](https://www.gnu.org/software/make/) (optional)
101+
102+
Install all dependencies and development dependencies:
103+
104+
```sh
105+
$ eask install-deps --dev
106+
```
107+
108+
To test the package's installation:
109+
110+
```sh
111+
$ eask package
112+
$ eask install
113+
```
114+
115+
To test compilation:
116+
117+
```sh
118+
$ eask compile
119+
```
120+
121+
**🪧 The following steps are optional, but we recommend you follow these lint results!**
122+
123+
The built-in `checkdoc` linter:
124+
125+
```sh
126+
$ eask lint checkdoc
127+
```
128+
129+
The standard `package` linter:
130+
131+
```sh
132+
$ eask lint package
133+
```
134+
135+
*📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.*
136+
137+
## ⚜️ License
138+
139+
This program is free software; you can redistribute it and/or modify
140+
it under the terms of the GNU General Public License as published by
141+
the Free Software Foundation, either version 3 of the License, or
142+
(at your option) any later version.
143+
144+
This program is distributed in the hope that it will be useful,
145+
but WITHOUT ANY WARRANTY; without even the implied warranty of
146+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
147+
GNU General Public License for more details.
148+
149+
You should have received a copy of the GNU General Public License
150+
along with this program. If not, see <https://www.gnu.org/licenses/>.
151+
152+
See [`LICENSE`](./LICENSE.txt) for details.

0 commit comments

Comments
 (0)