mirror of
https://github.com/emacs-vs/vs-dark-theme.git
synced 2025-12-05 18:20:30 -08:00
Update README.md
This commit is contained in:
parent
1f6f0afecc
commit
7f51c71ce8
1 changed files with 60 additions and 1 deletions
61
README.md
61
README.md
|
|
@ -12,7 +12,7 @@
|
|||
<img src="./etc/vs-dark-theme.png"/>
|
||||
</p>
|
||||
|
||||
## Contribute
|
||||
## 🛠️ Contribute
|
||||
|
||||
[](http://makeapullrequest.com)
|
||||
[](https://github.com/bbatsov/emacs-lisp-style-guide)
|
||||
|
|
@ -23,3 +23,62 @@ If you would like to contribute to this project, you may either
|
|||
clone and make pull requests to this repository. Or you can
|
||||
clone the project and establish your own branch of this tool.
|
||||
Any methods are welcome!
|
||||
|
||||
### 🔬 Development
|
||||
|
||||
To run the test locally, you will need the following tools:
|
||||
|
||||
- [Eask](https://emacs-eask.github.io/)
|
||||
- [Make](https://www.gnu.org/software/make/) (optional)
|
||||
|
||||
Install all dependencies and development dependencies:
|
||||
|
||||
```sh
|
||||
$ eask install-deps --dev
|
||||
```
|
||||
|
||||
To test the package's installation:
|
||||
|
||||
```sh
|
||||
$ eask package
|
||||
$ eask install
|
||||
```
|
||||
|
||||
To test compilation:
|
||||
|
||||
```sh
|
||||
$ eask compile
|
||||
```
|
||||
|
||||
**🪧 The following steps are optional, but we recommend you follow these lint results!**
|
||||
|
||||
The built-in `checkdoc` linter:
|
||||
|
||||
```sh
|
||||
$ eask lint checkdoc
|
||||
```
|
||||
|
||||
The standard `package` linter:
|
||||
|
||||
```sh
|
||||
$ eask lint package
|
||||
```
|
||||
|
||||
*📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.*
|
||||
|
||||
## ⚜️ License
|
||||
|
||||
This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
See [`LICENSE`](./LICENSE.txt) for details.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue