Skip to content

Commit 39677df

Browse files
committed
nit(readme): prettify
1 parent 376266a commit 39677df

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
![MinEmacs screenshot](assets/images/minemacs-screenshot.svg)
1212

1313
## Why?
14+
1415
Since many years, Emacs forms the foundation of my workflow, serving as my go-to
1516
tool for various tasks such as document writing, academic paper writing,
1617
programming in multiple languages, email management, and staying updated with
@@ -36,7 +37,7 @@ opinionated manner, CI commands, and even a profile manager! Each of these
3637
features introduced extra complexity and more failure points at every layer.
3738

3839
As a result, MinEmacs emerged as my personal configuration framework for Emacs,
39-
*and it continues to serve that purpose*. I'm trying to tailor it to my specific
40+
_and it continues to serve that purpose_. I'm trying to tailor it to my specific
4041
needs while maintaining its modularity and portability. You can refer to the
4142
[change log](CHANGELOG.md) for more information about the evolution of MinEmacs. However, I have
4243
no intention or availability to create an alternative to Doom Emacs or
@@ -47,6 +48,7 @@ really interested in becoming a full-time maintainer of this tool that I would
4748
only use to maintain itself!
4849

4950
## Install
51+
5052
Open a shell and run:
5153

5254
```shell
@@ -73,12 +75,14 @@ packages.
7375
> MinEmacs with versions earlier than 28.1, and I don't plan to do so!
7476
7577
## Customization
78+
7679
To personalize MinEmacs, you can incorporate a specific set of files within the
7780
default user configuration directory, which is located at `~/.minemacs.d`.
7881
However, if you prefer to use a different directory, you have the flexibility to
7982
do so by setting the `MINEMACSDIR` environment variable.
8083

8184
### Main configuration files
85+
8286
There are two main files that can be added in the `~/.minemacs.d` directory:
8387

8488
1. The `~/.minemacs.d/modules.el` file contains a list of enabled modules and a
@@ -95,6 +99,7 @@ using `require` directly (`require` loads the packages immediately, which increa
9599
the startup time of Emacs).
96100

97101
### Machine-specific configuration files
102+
98103
In my workflow, I use mainly the same configuration files across all my machines
99104
(which are traditionally shared in my [dotfiles](https://github.com/abougouffa/dotfiles) repository). However, I have some
100105
machine-specific (local) configurations that I like to load. For example, to
@@ -105,6 +110,7 @@ For this purpose, MinEmacs will also check for files in
105110
exists.
106111

107112
### Advanced configuration files
113+
108114
MinEmacs provides also some advanced customization files, these files can be
109115
used to tweak MinEmacs' behavior, add some early initialization code, make
110116
MinEmacs runnable on older Emacs versions, etc.
@@ -119,6 +125,7 @@ MinEmacs runnable on older Emacs versions, etc.
119125
functions MinEmacs uses. See the [`init.el`](init.el) for more information.
120126

121127
### Environment variables
128+
122129
You can customize MinEmacs' behavior via some environment variables.
123130

124131
- `MINEMACS_DIR` or `MINEMACSDIR`: Path for MinEmacs user configuration directory,
@@ -142,10 +149,11 @@ You can customize MinEmacs' behavior via some environment variables.
142149
user configuration files.
143150

144151
### Load and hooks order
152+
145153
MinEmacs loads its features and run hooks in this order:
146154

147155
- `~/.emacs.d/early-init.el`
148-
- `$MINEMACSDIR/early-config.el` *(unless disabled in `$MINEMACS_IGNORE_USER_CONFIG`)*
156+
- `$MINEMACSDIR/early-config.el` _(unless disabled in `$MINEMACS_IGNORE_USER_CONFIG`)_
149157
- `$MINEMACSDIR/local/early-config.el` _(unless disabled)_
150158
- `~/.emacs.d/init.el`
151159
- `before-init-hook`
@@ -174,11 +182,12 @@ Special hooks defined with `+make-first-file-hook!`:
174182
- `minemacs-first-org-file-hook`
175183

176184
## MinEmacs keybindings cheat sheet
185+
177186
MinEmacs defines several keybindings, mainly using [**general.el**](https://github.com/noctuid/general.el). To see the full
178187
list of keybindings defined using general, you can type `SPC h g` or `M-x
179188
general-describe-keybindings`.
180189

181190
## Troubleshooting
191+
182192
If you experienced an issue with MinEmacs, you can check the [FAQ](FAQ.md), check [open
183193
issues or open a new one](https://github.com/abougouffa/minemacs/issues).
184-

0 commit comments

Comments
 (0)