Skip to content

Commit e690f96

Browse files
committed
doc: update
1 parent abce21d commit e690f96

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,16 @@ on Emacs built-in feature.
2929

3030
## 📌 Dependencies
3131

32-
* [Node.js](https://nodejs.org/en/)
32+
* [Node.js](https://nodejs.org/en/) and [npm]()
3333
* [yargs](https://github.com/yargs/yargs)
3434
* [Emacs](https://www.gnu.org/software/emacs/) of course; make sure this is inside your environment PATH!
3535

3636
## 💾 Installation
3737

38+
You would need Node and npm to run this tool, see their official manual to
39+
https://nodejs.dev/learn/how-to-install-nodejs install it according to your
40+
system.
41+
3842
The easiest way to install is through tool [npm](https://www.npmjs.com/),
3943

4044
```sh
@@ -117,7 +121,7 @@ jobs:
117121
## 📝 About Eask file
118122
119123
`Eask` is the magic file that `eask` will read it as the init file in Emacs.
120-
The syntaxs are very similar to `Cask` file, but different.
124+
The syntaxes are very similar to the `Cask` file, but different.
121125

122126
```el
123127
(source "gnu")
@@ -152,7 +156,14 @@ For example, to enable compile on warn on `byte-compile` command
152156
* [cask](https://github.com/cask/cask) - Project management tool for Emacs
153157
* [makem.sh](https://github.com/alphapapa/makem.sh) - Makefile-like script for building and testing Emacs Lisp packages
154158

155-
## Project Development
159+
## Goals for the project
160+
161+
1. Consistent sandbox testing across all systems
162+
2. Has most commands that Emacsers often used (byte-compile, checkdoc, etc)
163+
3. No dependencies installed by default; only install packages when it's needed!
164+
4. Extra: Package Management Tool for your personal configuration/package
165+
166+
## Project Structure
156167

157168
N/A
158169

0 commit comments

Comments
 (0)