Skip to content

Latest commit

 

History

History
125 lines (86 loc) · 3.96 KB

README.md

File metadata and controls

125 lines (86 loc) · 3.96 KB
Raw

License: GPL v3 MELPA MELPA Stable

quelpa-leaf

CI

If you are using leaf (which can help to simplify your .emacs) you can use the quelpa handler provided by quelpa-leaf.

💾 Installation

Requirements: Emacs 25.1

Assuming you have bootstrapped quelpa, install quelpa-leaf (which installs leaf as a dependency) and require the library:

(quelpa
 '(quelpa-leaf
   :fetcher git
   :url "https://github.com/quelpa/quelpa-leaf.git"))
(require 'quelpa-leaf)
(quelpa-leaf-init)

🔧 Usage

After that it is possible to call leaf with the :quelpa keyword:

;; installs abc-mode with quelpa
(leaf abc-mode :quelpa)

;; does the same (`t' is optional)
(leaf abc-mode :quelpa t)

;; again... (if the package would have another name)
(leaf abc-mode :quelpa abc-mode)

;; passes upgrade parameter to quelpa
(leaf abc-mode :quelpa (:upgrade t))

;; uses the given recipe
(leaf abc-mode
  :quelpa (abc-mode :fetcher github :repo "mkjunker/abc-mode"))

;; recipe with plist arguments
(leaf abc-mode
  :quelpa ((abc-mode :fetcher github :repo "mkjunker/abc-mode") :upgrade t))

The quelpa handler is compatible with MELPA's recipe format. You may want to check the optional properties not mentioned above.

🛠️ Contribute

PRs Welcome Elisp styleguide Donate on paypal Become a patron

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:

Install all dependencies and development dependencies:

$ eask install-deps --dev

To test the package's installation:

$ eask package
$ eask install

To test compilation:

$ eask compile

🪧 The following steps are optional, but we recommend you follow these lint results!

The built-in checkdoc linter:

$ eask lint checkdoc

The standard package linter:

$ 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 for details.