summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAotrix <[email protected]>2025-12-31 22:00:13 +0100
committerAotrix <[email protected]>2025-12-31 22:00:13 +0100
commit8e58b7d7dcc73d1d8d53de15319fb98984c94905 (patch)
tree0f329407c5a43061ee865b950ea17db437974f26
parent766e707bc74753b7da0cec7176c7f1a5123d5588 (diff)
Added info about clang-format in README.md
-rw-r--r--README.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/README.md b/README.md
index 8a5ea84..7a94908 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,19 @@
## How to install this config
-- Clone the project in ~/.config/nvim folder.
+- Clone the project in $XDG_CONFIG_HOME/nvim folder (~/.config/nvim by default).
This is a C++ oriented neovim config which uses clang to analyse your code and LLDB to debug it. Thus, make sure that these tools are installed on your system.
## Requirements
-- Neovim >= 0.10
+- Neovim >= 0.11
- The following packages (please adapt to your distribution):
```bash
sudo pacman -S clang lldb cmake make unzip "python>=3.0"
```
You can also use Mason to install the first two tools.
-- Some formatters are used in this config, please check `~/.config/nvim/lua/aotrix/plugins/autoformat.lua` and install or remove the ones you need.
+
+Some formatters are used in this config, please check `~/.config/nvim/lua/aotrix/plugins/autoformat.lua` and install or remove the ones you need.
+On some Linux distributions you need to install ClangFormat separately, e.g., on Ubuntu:
+```bash
+sudo apt install clang-format
+```