Skip to content

Commit ffdaefd

Browse files
committed
Update docs
1 parent 14b3ef0 commit ffdaefd

3 files changed

Lines changed: 26 additions & 7 deletions

File tree

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,23 @@
77

88
# Ent
99

10-
`ent.el` is a **tiny build‑automation** framework written in pure Emacs‑Lisp.
10+
`ent` is designed as an alternative to tools like make or ant, but tailored specifically for the Emacs ecosystem. It allows developers to define and run build tasks using Elisp syntax directly within the editor.
1111

1212
Its goal is to discover a *project* (identified by a dedicated
1313
`ent‑project‑config‑filename` file), load the project‑specific build
1414
file, create a set of **tasks** (default and user‑defined) and run a
1515
selected task while reporting the output in a *compilation* buffer.
1616

1717

18-
# Install ent
18+
## Key Features
19+
20+
- **Pure Elisp:** Unlike make, which requires learning a specific DSL and relies on external shell commands, ent uses Emacs Lisp for task definitions, making it highly portable and integrated with Emacs internals.
21+
- **Project-Root Awareness:** It typically looks for a .ent.el file in the project root to define tasks.
22+
- **Task Dependencies:** It supports defining tasks that depend on other tasks, similar to traditional build systems.
23+
- **Integration:** Since it is native Elisp, it can easily interact with other Emacs packages, buffers, and the file system without spawning heavy external processes.
24+
25+
26+
## Install ent
1927

2028
;; update this after you publish your new package!
2129
;; (use-package ent) ; vanilla, assuming you have MELPA configured
@@ -39,7 +47,7 @@ selected task while reporting the output in a *compilation* buffer.
3947
:files ("lisp/*.el"))
4048

4149

42-
# Usage
50+
## Usage
4351

4452
First of all you need to create a build file `.ent.el` in the project root directory.
4553

doc/README.org

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,13 @@
1717
:UNNUMBERED: notoc
1818
:END:
1919

20-
#+include: "manual.org::*Overview" :only-contents t
20+
#+include: "manual.org::*Overview" :only-contents t
2121

22-
* Install ent
22+
** Key Features
23+
24+
#+include: "manual.org::*Key Features" :only-contents t
25+
26+
** Install ent
2327
:PROPERTIES:
2428
:UNNUMBERED: notoc
2529
:END:
@@ -47,7 +51,7 @@
4751
:files ("lisp/*.el"))
4852
#+end_src
4953

50-
* Usage
54+
** Usage
5155

5256
#+include: "manual.org::*Usage" :only-contents t
5357

doc/manual.org

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,20 @@ the README.
2424

2525
* Overview
2626

27-
=ent.el= is a *tiny build‑automation* framework written in pure Emacs‑Lisp.
27+
=ent= is designed as an alternative to tools like make or ant, but tailored specifically for the Emacs ecosystem. It allows developers to define and run build tasks using Elisp syntax directly within the editor.
2828

2929
Its goal is to discover a /project/ (identified by a dedicated
3030
=ent‑project‑config‑filename= file), load the project‑specific build
3131
file, create a set of *tasks* (default and user‑defined) and run a
3232
selected task while reporting the output in a /compilation/ buffer.
3333

34+
* Key Features
35+
36+
- Pure Elisp :: Unlike make, which requires learning a specific DSL and relies on external shell commands, ent uses Emacs Lisp for task definitions, making it highly portable and integrated with Emacs internals.
37+
- Project-Root Awareness :: It typically looks for a .ent.el file in the project root to define tasks.
38+
- Task Dependencies :: It supports defining tasks that depend on other tasks, similar to traditional build systems.
39+
- Integration :: Since it is native Elisp, it can easily interact with other Emacs packages, buffers, and the file system without spawning heavy external processes.
40+
3441
* Usage
3542

3643
First of all you need to create a build file ~.ent.el~ in the project root directory.

0 commit comments

Comments
 (0)