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