Skip to content

Commit a4f03bf

Browse files
committed
doc: update
1 parent c485395 commit a4f03bf

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ on Emacs built-in feature.
2121
- [About CI/CD](#about-cicd)
2222
- [📝 About Eask file](#📝-about-eask-file)
2323
- [📂 Related Projects](#📂-related-projects)
24-
- [Project Development](#project-development)
25-
- [Focus](#focus)
24+
- [🏆 Goals for the project](#🏆-goals-for-the-project)
25+
- [Project Structure](#project-structure)
2626
- [Contribute](#contribute)
2727

2828
<!-- markdown-toc end -->
@@ -152,7 +152,7 @@ For example, to enable compile on warn on `byte-compile` command
152152
* [cask](https://github.com/cask/cask) - Project management tool for Emacs
153153
* [makem.sh](https://github.com/alphapapa/makem.sh) - Makefile-like script for building and testing Emacs Lisp packages
154154

155-
## Goals for the project
155+
## 🏆 Goals for the project
156156

157157
1. Consistent sandbox testing across all systems
158158
2. Has most commands that Emacsers often used (byte-compile, checkdoc, etc)
@@ -161,11 +161,16 @@ For example, to enable compile on warn on `byte-compile` command
161161

162162
## Project Structure
163163

164-
N/A
164+
The project structure are very simple, all we need is to look into 3 places.
165165

166-
## Focus
166+
1. `eask` file at the root of the project
167+
2. `cmds` folder with all available commands
168+
3. `lisp` folder with all elisp code
167169

168-
N/A
170+
`eask` is the node entry, and the main yargs definition! `cmds` and `lisp`
171+
folders are command files that correspond to each other.
172+
173+
The sandbox logic is stored inside file `./lisp/_prepare.el`.
169174

170175
## Contribute
171176

0 commit comments

Comments
 (0)