Skip to content

Commit 8266662

Browse files
committed
Add readme
1 parent 4aa9064 commit 8266662

File tree

1 file changed

+82
-1
lines changed

1 file changed

+82
-1
lines changed

README.md

Lines changed: 82 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,83 @@
1+
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
2+
[![JCS-ELPA](https://raw.githubusercontent.com/jcs-emacs/badges/master/elpa/v/jcs-screensaver.svg)](https://jcs-emacs.github.io/jcs-elpa/#/jcs-screensaver)
3+
<a href="https://jcs-emacs.github.io/"><img align="right" src="https://raw.githubusercontent.com/jcs-emacs/badges/master/others/built-with/dark.svg" alt="Built with"></a>
4+
15
# jcs-screensaver
2-
A screensaver for jcs-emacs
6+
> A screensaver for `jcs-emacs`
7+
8+
[![CI](https://github.com/jcs-emacs/jcs-screensaver/actions/workflows/test.yml/badge.svg)](https://github.com/jcs-emacs/jcs-screensaver/actions/workflows/test.yml)
9+
10+
## 🔨 Usage
11+
12+
Just `M-x jcs-screensaver`!
13+
14+
## 🛠️ Contribute
15+
16+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
17+
[![Elisp styleguide](https://img.shields.io/badge/elisp-style%20guide-purple)](https://github.com/bbatsov/emacs-lisp-style-guide)
18+
[![Donate on paypal](https://img.shields.io/badge/paypal-donate-1?logo=paypal&color=blue)](https://www.paypal.me/jcs090218)
19+
[![Become a patron](https://img.shields.io/badge/patreon-become%20a%20patron-orange.svg?logo=patreon)](https://www.patreon.com/jcs090218)
20+
21+
If you would like to contribute to this project, you may either
22+
clone and make pull requests to this repository. Or you can
23+
clone the project and establish your own branch of this tool.
24+
Any methods are welcome!
25+
26+
### 🔬 Development
27+
28+
To run the test locally, you will need the following tools:
29+
30+
- [Eask](https://emacs-eask.github.io/)
31+
- [Make](https://www.gnu.org/software/make/) (optional)
32+
33+
Install all dependencies and development dependencies:
34+
35+
```sh
36+
$ eask install-deps --dev
37+
```
38+
39+
To test the package's installation:
40+
41+
```sh
42+
$ eask package
43+
$ eask install
44+
```
45+
46+
To test compilation:
47+
48+
```sh
49+
$ eask compile
50+
```
51+
52+
**🪧 The following steps are optional, but we recommend you follow these lint results!**
53+
54+
The built-in `checkdoc` linter:
55+
56+
```sh
57+
$ eask lint checkdoc
58+
```
59+
60+
The standard `package` linter:
61+
62+
```sh
63+
$ eask lint package
64+
```
65+
66+
*📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.*
67+
68+
## ⚜️ License
69+
70+
This program is free software; you can redistribute it and/or modify
71+
it under the terms of the GNU General Public License as published by
72+
the Free Software Foundation, either version 3 of the License, or
73+
(at your option) any later version.
74+
75+
This program is distributed in the hope that it will be useful,
76+
but WITHOUT ANY WARRANTY; without even the implied warranty of
77+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
78+
GNU General Public License for more details.
79+
80+
You should have received a copy of the GNU General Public License
81+
along with this program. If not, see <https://www.gnu.org/licenses/>.
82+
83+
See [`LICENSE`](./LICENSE) for details.

0 commit comments

Comments
 (0)