Skip to content

Commit b87884c

Browse files
committed
docs: Improve intro
1 parent 528a656 commit b87884c

File tree

3 files changed

+39
-41
lines changed

3 files changed

+39
-41
lines changed

README.md

+13-14
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,23 @@
77
[![Release](https://img.shields.io/github/release/emacs-eask/cli.svg?logo=github)](https://github.com/emacs-eask/cli/releases/latest)
88
[![Discord](https://img.shields.io/discord/1131434607213023262?label=Discord&logo=discord&logoColor=white&color=7289DA)](https://discord.gg/E9zzjWGfFD)
99

10-
Eask was built to use as a package development tool in your Elisp packages. But
11-
now, Eask supports various types of Emacs Lisp tasks. It can be used in three
12-
major ways:
10+
Eask was originally designed as a package development tool for Elisp projects.
11+
However, it has since expanded to support a wide range of Emacs Lisp tasks.
12+
It can now be used in three major ways:
1313

14-
1. Dev tool for Elisp packages
15-
2. Dependency management for your configuration
16-
3. Run elisp programs for all other purposes
14+
1. As a development tool for Elisp packages.
15+
2. For managing dependencies in your Emacs configuration.
16+
3. To run Elisp programs for a variety of purposes (essentially functioning as a runtime).
1717

18-
So, other than the things above, what are the major differences between Eask
19-
and other build tools like [Cask][], [makem.sh][], and [Eldev][]?
18+
With these capabilities in mind, what sets Eask apart from other build tools
19+
like [Cask][], [makem.sh][], and [Eldev][]?
2020

21-
Good question! Eask is more than a build tool now, it can be used for various
22-
purposes! But here are Eask aims to be:
21+
Great question! Eask has evolved beyond just a build tool—it serves multiple purposes! Here’s what Eask aims to be:
2322

24-
- **Consistent** enough to sandbox across all systems
25-
- **General** enough to have Emacsers frequently used commands (`byte-compile`, `checkdoc`, etc)
26-
- **Robust** enough to provide useful results even in the presence of user errors
27-
- **Dependency-free** so that the tool can be run on any platform
23+
- **Consistent**: Provides a reliable sandboxing environment across all systems.
24+
- **Versatile**: Includes commonly used Emacs commands like `byte-compilation`, `checkdoc`, and more.
25+
- **Robust**: Delivers useful results even when user errors occur.
26+
- **Lightweight**: Runs on any platform without dependencies.
2827

2928
*📝 P.S. See [Why Eask?](https://emacs-eask.github.io/Getting-Started/Introduction/#-why-eask) for more detailed
3029
information.*

docs/content/Getting-Started/Introduction/_index.en.md

+14-15
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,25 @@ title: 🚪 Introduction
33
weight: 0
44
---
55

6-
Eask was built to use as a package development tool in your Elisp packages. But
7-
now, Eask supports various types of Emacs Lisp tasks. It can be used in three
8-
major ways:
6+
Eask was originally designed as a package development tool for Elisp projects.
7+
However, it has since expanded to support a wide range of Emacs Lisp tasks.
8+
It can now be used in three major ways:
99

10-
1. Dev tool for Elisp packages
11-
2. Dependency management for your configuration
12-
3. Run elisp programs for all other purposes
10+
1. As a development tool for Elisp packages.
11+
2. For managing dependencies in your Emacs configuration.
12+
3. To run Elisp programs for a variety of purposes (essentially functioning as a runtime).
1313

14-
So, other than the things above, what are the major differences between Eask
15-
and other build tools like [Cask][], [makem.sh][], and [Eldev][]?
14+
With these capabilities in mind, what sets Eask apart from other build tools
15+
like [Cask][], [makem.sh][], and [Eldev][]?
1616

17-
Good question! Eask is more than a build tool now, it can be used for various
18-
purposes! But here are Eask aims to be:
17+
Great question! Eask has evolved beyond just a build tool—it serves multiple purposes! Here’s what Eask aims to be:
1918

20-
- **Consistent** enough to sandbox across all systems
21-
- **General** enough to have Emacsers frequently used commands (`byte-compile`, `checkdoc`, etc)
22-
- **Robust** enough to provide useful results even in the presence of user errors
23-
- **Dependency-free** so that the tool can be run on any platform
19+
- **Consistent**: Provides a reliable sandboxing environment across all systems.
20+
- **Versatile**: Includes commonly used Emacs commands like `byte-compilation`, `checkdoc`, and more.
21+
- **Robust**: Delivers useful results even when user errors occur.
22+
- **Lightweight**: Runs on any platform without dependencies.
2423

25-
*📝 P.S. See [Why Eask?](https://emacs-eask.github.io/#-why-eask) for more detailed
24+
*📝 P.S. See [Why Eask?](https://emacs-eask.github.io/Getting-Started/Introduction/#-why-eask) for more detailed
2625
information.*
2726

2827
## ❓ Why Eask?

docs/content/Getting-Started/Introduction/_index.zh-tw.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,23 @@ title: 🚪 介紹
33
weight: 0
44
---
55

6-
Eask 被構建為用作 Elisp 包中的包開發工具。 但是現在,Eask 支持各種類型的 Emacs Lisp 任務。
7-
它可以通過三種主要方式使用
6+
Eask 原本是為 Elisp 專案設計的套件開發工具。然而,它後來擴展到支援廣泛的 Emacs Lisp 任務。
7+
現在它可以用在三個主要方面
88

9-
1. Elisp 包的開發工具
10-
2. 配置的依賴管理
11-
3. 為所有其他目的運行 elisp 程序
9+
1. 作為 Elisp 套件的開發工具。
10+
2. 用於管理 Emacs 設定中的相依性。
11+
3. 運行 Elisp 程式以達到各種目的 (本質上作為運行時)。
1212

13-
那麼,除上述內容外,Eask 與其他構建工具(如 [Cask][][makem.sh][][Eldev][] 之間的主要區別是什麼
13+
考慮到這些功能,Eask [Cask][][makem.sh][][Eldev][] 等其他編譯工具有何不同
1414

15-
好問題! Eask 現在不僅僅是一個構建工具,它可以用於各種目的! 但 Eask 的目標是
15+
很好的問題!Eask 已經不僅僅是一個編譯工具,它還具有多種用途!以下是 Eask 的目標
1616

17-
- **一致**足以跨所有系統進行沙盒
18-
- **通用**足以讓 Emacsers 經常使用命令(`byte-compile``checkdoc`
19-
- **穩健**即使在出現用戶錯誤的情況下也足以提供有用的結果
20-
- **無依賴**,使該工具可以在任何平台上運行
17+
- **一致性**: 在所有系統中提供可靠的沙箱環境。
18+
- **多功能**: 包含常用的 Emacs 指令,如 `byte-compilation``checkdoc`
19+
- **可靠**: 即使發生使用者錯誤,也能提供有用的結果。
20+
- **輕量級**: 可在任何平台上執行,無須依賴任何平台。
2121

22-
*📝 附言 有關更多詳細信息,請參閱[為什麼使用 Eask?](https://emacs-eask.github.io/#-why-eask)*
22+
*📝 P.S. 詳細資訊請參閱 [為什麼選擇 Eask?](https://emacs-eask.github.io/zh-tw/Getting-Started/Introduction/#-%e7%82%ba%e4%bb%80%e9%ba%bc%e9%81%b8%e6%93%87-eask)*
2323

2424
## ❓ 為什麼選擇 Eask?
2525

0 commit comments

Comments
 (0)