Skip to content
This repository was archived by the owner on Dec 19, 2022. It is now read-only.

Clarify where to place init.lua and how to load modules #113

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Clarify where to place init.lua and how to load modules #113

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ A few tutorials have already been written to help people write plugins in Lua. S

### init.lua

Neovim supports loading an `init.lua` file for configuration instead of the usual `init.vim`.
Neovim loads scripts starting from `init.lua` or the usual `init.vim` located in `'runtimepath'` (for most users, this will mean `~/.config/nvim/lua` on \*nix systems and `~/AppData/Local/nvim/lua` on Windows).

Note: `init.lua` is of course _completely_ optional. Support for `init.vim` is not going away and is still a valid option for configuration. Do keep in mind that some features are not 100% exposed to Lua yet.

Expand All @@ -70,7 +70,7 @@ See also:

### Modules

Lua modules are found inside a `lua/` folder in your `'runtimepath'` (for most users, this will mean `~/.config/nvim/lua` on \*nix systems and `~/AppData/Local/nvim/lua` on Windows). You can `require()` files in this folder as Lua modules.
Lua modules are placed inside a `lua/` folder in your `'runtimepath'`. You can `require()` files from this folder from `init.lua` (or `init.vim`) script.

Let's take the following folder structure as an example:

Expand Down