= Eldev
:docinfo: shared
:doctype: book
:title: Eldev documentation
:toc: left
:toc-title: Table of contents
:source-language: lisp
:icons: font
:empty:
:uri-xdg: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
:uri-search-github: https://github.com/search?q=path%3A%2F%5EEldev%24%2F&type=code
:uri-git-hooks: https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks#_git_hooks
:uri-flycheck: https://www.flycheck.org/
:uri-flycheck-eldev: https://github.com/flycheck/flycheck-eldev
:uri-flymake: https://www.gnu.org/software/emacs/manual/html_node/emacs/Flymake.html
:uri-flymake-eldev: https://github.com/emacs-eldev/flymake-eldev
:uri-ert: https://www.gnu.org/software/emacs/manual/html_node/ert/index.html
:uri-ert-sel: https://www.gnu.org/software/emacs/manual/html_node/ert/Test-Selectors.html
:uri-buttercup: https://github.com/jorgenschaefer/emacs-buttercup
:uri-buttercup-rt: https://github.com/jorgenschaefer/emacs-buttercup/blob/master/docs/running-tests.md
:uri-doctest: https://github.com/ag91/doctest
:uri-ecukes: https://github.com/ecukes/ecukes
:uri-cask: https://github.com/cask/cask
:uri-makem-sh: https://github.com/alphapapa/makem.sh
:uri-eask: https://github.com/emacs-eask/cli
:uri-keg: https://github.com/conao3/keg.el
:uri-makel: https://gitea.petton.fr/DamienCassou/makel
:uri-emake: https://github.com/vermiculus/emake.el
:uri-evm: https://github.com/rejeep/evm
:uri-nix-emacs: https://github.com/purcell/nix-emacs-ci
:uri-package-lint: https://github.com/purcell/package-lint
:uri-relint: https://github.com/mattiase/relint
:uri-elisp-lint: https://github.com/gonewest818/elisp-lint/
:uri-projectile: https://github.com/bbatsov/projectile
:uri-magit: https://github.com/magit/magit
:uri-github-wflows: https://help.github.com/en/actions
:uri-github-wflows-vars: https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables
:uri-travis: https://travis-ci.org/
:uri-circle: https://circleci.com/
:uri-docker: https://www.docker.com/
:uri-podman: https://podman.io/
:uri-coveralls: https://coveralls.io/
:uri-setup-emacs: https://github.com/jcs090218/setup-emacs
:uri-setup-eldev: https://github.com/emacs-eldev/setup-eldev
:uri-undercover: https://github.com/undercover-el/undercover.el
:uri-extmap: https://github.com/doublep/extmap
:uri-iter2: https://github.com/doublep/iter2
:uri-logview: https://github.com/doublep/logview
:uri-datetime: https://github.com/doublep/datetime
:uri-docker-emacs: https://github.com/Silex/docker-emacs
:uri-docker-emacs-images: https://github.com/Silex/docker-emacs#images
:uri-release-it: https://github.com/release-it/release-it
:uri-emacs-forwarding: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=56745
:uri-guix: https://guix.gnu.org/
:since-0-1-1: image:https://img.shields.io/badge/since-0.1.1-8be[Since 0.1.1,float=right]
:since-0-2: image:https://img.shields.io/badge/since-0.2-8be[Since 0.2,float=right]
:since-0-2-1: image:https://img.shields.io/badge/since-0.2.1-8be[Since 0.2.1,float=right]
:since-0-3: image:https://img.shields.io/badge/since-0.3-8be[Since 0.3,float=right]
:since-0-3-2: image:https://img.shields.io/badge/since-0.3.2-8be[Since 0.3.2,float=right]
:since-0-4: image:https://img.shields.io/badge/since-0.4-8be[Since 0.4,float=right]
:since-0-5: image:https://img.shields.io/badge/since-0.5-8be[Since 0.5,float=right]
:since-0-6: image:https://img.shields.io/badge/since-0.6-8be[Since 0.6,float=right]
:since-0-7: image:https://img.shields.io/badge/since-0.7-8be[Since 0.7,float=right]
:since-0-8: image:https://img.shields.io/badge/since-0.8-8be[Since 0.8,float=right]
:since-0-9: image:https://img.shields.io/badge/since-0.9-8be[Since 0.9,float=right]
:since-0-10: image:https://img.shields.io/badge/since-0.10-8be[Since 0.10,float=right]
:since-0-11: image:https://img.shields.io/badge/since-0.11-8be[Since 0.11,float=right]
:since-1-1: image:https://img.shields.io/badge/since-1.1-8be[Since 1.1,float=right]
:since-1-2: image:https://img.shields.io/badge/since-1.2-8be[Since 1.2,float=right]
:since-1-3: image:https://img.shields.io/badge/since-1.3-8be[Since 1.3,float=right]
:since-1-4: image:https://img.shields.io/badge/since-1.4-8be[Since 1.4,float=right]
:since-1-4-1: image:https://img.shields.io/badge/since-1.4.1-8be[Since 1.4.1,float=right]
:since-1-5: image:https://img.shields.io/badge/since-1.5-8be[Since 1.5,float=right]
:since-1-6: image:https://img.shields.io/badge/since-1.6-8be[Since 1.6,float=right]
:since-1-7: image:https://img.shields.io/badge/since-1.7-8be[Since 1.7,float=right]
:since-1-8: image:https://img.shields.io/badge/since-1.8-8be[Since 1.8,float=right]
:since-1-9: image:https://img.shields.io/badge/since-1.9-8be[Since 1.9,float=right]
:since-1-10: image:https://img.shields.io/badge/since-1.10-8be[Since 1.10,float=right]
:since-1-11: image:https://img.shields.io/badge/since-1.11-8be[Since 1.11,float=right]


toc::[]


Eldev (Elisp development tool) is an Emacs-based build tool, targeted
solely at Elisp projects.  It is an alternative to Cask.  Unlike Cask,
Eldev itself is fully written in Elisp and its configuration files are
also Elisp programs.  If you are familiar with Java world, Cask can be
seen as a parallel to Maven — it uses project _description_, while
Eldev is sort of a parallel to Gradle — its configuration is a
_program_ on its own.

image:https://img.shields.io/badge/license-GPL_3-green.svg[License: GPL 3, link=http://www.gnu.org/licenses/gpl-3.0.txt]
image:https://img.shields.io/github/release/emacs-eldev/eldev.svg[Latest release, link=https://github.com/emacs-eldev/eldev/releases]


include::overview.adoc[]

include::requirements.adoc[]

include::installation.adoc[]

include::safety.adoc[]

include::getting-started.adoc[]

include::initializing.adoc[]

include::setup-procedure.adoc[]

include::project-dependencies.adoc[]

include::loading-modes.adoc[]

include::build-system.adoc[]

include::testing.adoc[]

include::linting.adoc[]

include::evaluating-expressions.adoc[]

include::running-emacs.adoc[]

include::profiling.adoc[]

include::emacs-versions.adoc[]

include::continuous-integration.adoc[]

include::debugging.adoc[]

include::plugins.adoc[]

include::filesets.adoc[]

include::extending-eldev.adoc[]

include::environment-variables.adoc[]

include::see-also.adoc[]
