Skip to content

Commit

Permalink
[#311] Document dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
raxod502 committed Sep 3, 2024
1 parent e2e9b39 commit b3642d1
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,23 @@ to install it using
However, you may install using any other package manager if you
prefer.

### Dependencies

Emacs 27 or later is supported. Apheleia does not include any
formatters. You must install any formatter separately that you wish to
use. As long as it is on `$PATH` then Apheleia will pick it up
automatically; missing formatters will silently be skipped, but errors
from invoking installed formatters will be reported on buffer save.

It is recommended to have Bash installed, as this is used as a
dependency for Apheleia to invoke certain formatters (e.g.
Node.js-based formatters).

Windows support is not guaranteed due to lack of support for common
open standards on this platform. Pull requests adjusting Apheleia for
improved cross-platform portability will be accepted, but no
guarantees are made about stability on Windows.

## User guide

To your init-file, add the following form:
Expand Down

0 comments on commit b3642d1

Please sign in to comment.