Browse Source

Merge branch 'add-makem' of DamienCassou/makel into master

master
Damien Cassou 9 months ago
committed by Gitea
parent
commit
90f2232469
1 changed files with 19 additions and 9 deletions
  1. +19
    -9
      README.org

+ 19
- 9
README.org View File

@@ -1,8 +1,10 @@
* makel

#+begin_export html
<a href="https://drone.petton.fr/DamienCassou/makel">
<img src="https://drone.petton.fr/api/badges/DamienCassou/makel/status.svg" />
</a>
#+end_export

** Summary

@@ -12,15 +14,15 @@ tests). The Makefile can be used both locally on the developer machine
and remotely on a continuous integration machine. These are the rules
provided by ~makel.mk~:

- *test-ert* : run your ERT (the Emacs Lisp Regression Testing tool) tests.
- *test-buttercup* : run your [[https://github.com/jorgenschaefer/emacs-buttercup][buttercup]] tests.
- *lint-checkdoc* : collect and report checkdoc (the Emacs coding convention tool) errors.
- *lint-package-lint* : collect and report [[https://github.com/purcell/package-lint][package-lint]] (a linting library for package definitions) errors.
- *lint-compile* : collect and report errors and warnings from the Emacs Lisp compiler.
- *lint* : starts all linting-related rules.
- *test* : starts all test-related rules (both ert and buttercup tests).
- *check* : starts all lint and test rules.
- *makel-version* : displays makel's version
- test-ert :: run your ERT (the Emacs Lisp Regression Testing tool) tests.
- test-buttercup :: run your [[https://github.com/jorgenschaefer/emacs-buttercup][buttercup]] tests.
- lint-checkdoc :: collect and report checkdoc (the Emacs coding convention tool) errors.
- lint-package-lint :: collect and report [[https://github.com/purcell/package-lint][package-lint]] (a linting library for package definitions) errors.
- lint-compile :: collect and report errors and warnings from the Emacs Lisp compiler.
- lint :: starts all linting-related rules.
- test :: starts all test-related rules (both ert and buttercup tests).
- check :: starts all lint and test rules.
- makel-version :: displays makel's version

What distinguishes makel from similar tools (see below) is its
simplicity: simplicity to use it in your Emacs package (there are just
@@ -167,6 +169,7 @@ and could act as examples:
If you are looking for something similar to makel, you might be
interested in these projects:

- [[https://github.com/alphapapa/makem.sh][makem.sh]]
- [[https://github.com/cask/cask][Cask]]
- [[https://github.com/vermiculus/emake.el/][EMake]]
- [[https://github.com/doublep/eldev][Eldev]]
@@ -176,6 +179,11 @@ for some time. My opinion is that makel is simpler to use and maintain
(it's only a Makefile and it has many unit tests) but may lack some
features you might need.

Regarding makem.sh, I suggest you try it if you like makel. It seems
like it's a better version of it: more features, more documentation,
easier to setup. I haven't used it yet but I will probably try it
soon.

Regarding Cask, I was frustrated by the complexity (I mean
understanding how things work and play together) and warnings/errors I
and others would regularly get.
@@ -192,6 +200,8 @@ quality of the code.

See [[file:COPYING][COPYING]]. Copyright (c) 2018-2019 Damien Cassou.

#+begin_export html
<a href="https://liberapay.com/DamienCassou/donate">
<img alt="Donate using Liberapay" src="https://liberapay.com/assets/widgets/donate.svg">
</a>
#+end_export

Loading…
Cancel
Save