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

doc: fixes org bold marks

Browse Source
This commit is contained in:
Rahul Martim Juliato
2024-10-03 17:41:00 -03:00
parent 9a2942545f
commit 341a479c63
1 changed files with 21 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
README.org
View File

@@ -1,37 +1,37 @@
* Emacs-Kick(starter) for Vim/Neovim Users
Welcome to **Emacs-Kick**, a feature-rich Emacs configuration designed
for users familiar with **Vim**, **Neovim**, and **Vi**. With this
Welcome to *Emacs-Kick*, a feature-rich Emacs configuration designed
for users familiar with *Vim* *Neovim*, and *Vi*. With this
setup, you don't need to leave behind your favorite terminal or tools
like **yazi**, **starship**, **lazygit**, and **lazydocker** just to give
like *yazi*, *starship*, *lazygit*, and *lazydocker* just to give
Emacs a try.
Use Emacs the same way you'd use **Neovim**, seamlessly integrating it
into your workflow inside terminal multiplexers like **tmux** or
**Zellij**, while also enjoying modern features such as **treesitter**
and **LSP**—no hassle.
Use Emacs the same way you'd use *Neovim*, seamlessly integrating it
into your workflow inside terminal multiplexers like *tmux* or
*Zellij*, while also enjoying modern features such as *treesitter*
and *LSP*—no hassle.
TODO: [Insert nice screenshot here]
**Emacs-Kick** is not a distribution, but a starting point for your
*Emacs-Kick* is not a distribution, but a starting point for your
own configuration. It’s designed to be accessible to Vim/Neovim users
without needing to adopt all of Emacs' ecosystem. You can still enjoy
the power of Emacs without having to learn every Emacs-specific
workflow.
**Minimum Requirements**:
- Emacs version **29+**
*Minimum Requirements*:
- Emacs version *29+*
- You can verify your version by running:
#+BEGIN_SRC bash
emacs --version
#+END_SRC
**Installation Instructions**:
*Installation Instructions*:
1. **Clone the repository**:
1. *Clone the repository*:
**Note**: If you already have an existing Emacs configuration in
*Note*: If you already have an existing Emacs configuration in
`~/.emacs.d`, please back it up before proceeding. You can do this
by renaming the directory:
@@ -46,7 +46,7 @@ workflow.
#+END_SRC
2. **Run the setup**:
2. *Run the setup*:
After cloning, install the configuration by running:
@@ -65,9 +65,9 @@ workflow.
configuration.
3. **Set terminal mode by default**:
3. *Set terminal mode by default*:
**Note on Emacs modes**: Emacs automatically adapts to either
*Note on Emacs modes*: Emacs automatically adapts to either
graphical or terminal mode depending on the environment. But if you're
in a graphical session and prefer terminal mode, just use:
@@ -89,7 +89,7 @@ workflow.
source ~/.zshrc # for zsh
#+END_SRC
4. **Start Emacs**:
4. *Start Emacs*:
Once set up, start Emacs with:
@@ -97,16 +97,16 @@ workflow.
emacs
#+END_SRC
**Usage Tips**:
- **Leader Key**: The leader key is set to `SPC` (spacebar), similar
*Usage Tips*:
- *Leader Key*: The leader key is set to `SPC` (spacebar), similar
to Vim.
- **Help Commands**:
- *Help Commands*:
- `SPC h i` opens the Emacs info documentation (`M-x info`).
- `SPC h v` allows you to explore available variables.
- `SPC h f` lets you explore functions.
- `SPC h k` displays keybindings.
**Troubleshooting**:
*Troubleshooting*:
- If you encounter any issues during installation, check the
`*Messages*` buffer for more information. You can switch between
buffers with `SPC SPC`, and navigate options using `C-p` and `C-n`.