jsbeckr/emacs.d
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: improve overall documentation

Browse Source
This commit is contained in:
Rahul Martim Juliato
2025-08-01 17:11:03 -03:00
committed by Rahul M. Juliato
parent e8a0ec8de9
commit 6a25d10be3
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -29,7 +29,7 @@ give Emacs a try.
Use Emacs the same way you'd use `Neovim`, seamlessly integrating it Use Emacs the same way you'd use `Neovim`, seamlessly integrating it
into your workflow inside terminal multiplexers like `tmux` or into your workflow inside terminal multiplexers like `tmux` or
`Zellij`, while also enjoying modern features such as `treesitter` `Zellij`, while also enjoying modern features such as `treesitter`
and `LSP`—no hassle. and `LSP`, no hassle.
![Demo](doc/demo01.png) ![Demo](doc/demo01.png)
@@ -49,10 +49,9 @@ enjoying it, you can:
OR... OR...
- Just keep using it on TUI, it is all up to you! - Just keep using it on TUI, it is all up to you!
With Emacs-Kick, the goal is to empower you to explore Emacs at your With `Emacs-Kick`, the goal is to empower you to explore Emacs at your
own pace. The sky's the limit! 🌟 own pace. The sky's the limit! 🌟
## Minimum Requirements ## Minimum Requirements
- Emacs version **>=30.1** - Emacs version **>=30.1**
@@ -68,7 +67,7 @@ development version on Emacs master branch).
### macOS Warning ### macOS Warning
On macOS, `emacs-kick` may fail to function correctly due to missing or On macOS, `Emacs-Kick` may fail to function correctly due to missing or
incompatible system utilities. To avoid common issues, make sure the incompatible system utilities. To avoid common issues, make sure the
following tools are installed via Homebrew: following tools are installed via Homebrew:
@@ -137,12 +136,13 @@ configuration.
**NOTE**: During the initial setup, you'll be prompted to install Tree-sitter **NOTE**: During the initial setup, you'll be prompted to install Tree-sitter
grammars and download some fonts. This configuration uses **Nerd Fonts** by grammars and download some fonts. This configuration uses **Nerd Fonts** by
default, so installing them now is highly recommended for the best experience. default, so installing them now is highly recommended for the best experience.
On first launch, Emacs will also **native compile some external packages**,
which may take a little time. Additionally, the first time you perform certain **VERY IMPORTANT**: On first launch, Emacs will also **native compile some
actions—like opening the tree explorer, Emacs may compile related components in external packages**, which may take a little time. Additionally, the first time
the background. This is completely normal and only happens once per feature. you perform certain actions, like opening the tree explorer, Emacs may compile
You might notice a brief moment of sluggish performance during this initial related components in the background. This is completely normal and only
compilation. happens once per feature. You might notice a brief moment of sluggish
performance during this initial compilation.
3. **Set terminal mode by default**: 3. **Set terminal mode by default**: