https://github.com/emacs-eask/template-elisp
Template elisp project for `eask create package`
https://github.com/emacs-eask/template-elisp
eask emacs init starter template
Last synced: 12 months ago
JSON representation
Template elisp project for `eask create package`
- Host: GitHub
- URL: https://github.com/emacs-eask/template-elisp
- Owner: emacs-eask
- Created: 2022-04-28T11:40:32.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-02-11T01:49:29.000Z (about 1 year ago)
- Last Synced: 2025-04-10T21:13:52.234Z (12 months ago)
- Topics: eask, emacs, init, starter, template
- Language: Makefile
- Homepage:
- Size: 19.5 KB
- Stars: 3
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
This project was bootstrapped with [eask/cli](https://github.com/emacs-eask/cli).
## How to use?
1. Write and design your package in `your-package.el`
2. Install package dependences if any:
```sh
eask install-deps
```
3. Prepare for installation, package it: (it will create package to `dist` folder)
```sh
eask package
```
4. Install the built package:
```sh
eask install
```
## Compile
You would want to compile your elisp file to check if there are errors:
```sh
eask compile
```
## Cleaning
Simply executes the following:
```sh
eask clean all
```
For more options, see `eask clean --help`!
## Linting
Linting is often optional but recommended to all elisp developers.
with `checkdoc`:
```sh
eask lint checkdoc
```
with `package-lint`:
```sh
eask lint package # for package-lint
```
For more options, see `eask lint --help`!
## Testing
Eask supports [ERT](https://www.gnu.org/software/emacs/manual/html_node/ert/index.html)
, [Buttercup](https://github.com/jorgenschaefer/emacs-buttercup)
, [Ecukes](https://github.com/ecukes/ecukes), and more.
For more options, see `eask test --help`!
## Continuous Integration
### GitHub Actions
```sh
eask generate workflow github
```
### CircleCI
```sh
eask generate workflow circle-ci
```
For more options, see `eask generate workflow --help`!
## Learn More
To learn Eask, check out the [Eask documentation](https://github.com/emacs-eask).