mirror of
https://github.com/Baipyrus/nvim-config.git
synced 2024-08-17 02:19:44 +00:00
107 lines
4.3 KiB
Lua
107 lines
4.3 KiB
Lua
--[[
|
|
|
|
=====================================================================
|
|
==================== READ THIS BEFORE CONTINUING ====================
|
|
=====================================================================
|
|
======== .-----. ========
|
|
======== .----------------------. | === | ========
|
|
======== |.-""""""""""""""""""-.| |-----| ========
|
|
======== || || | === | ========
|
|
======== || KICKSTART.NVIM || |-----| ========
|
|
======== || || | === | ========
|
|
======== || || |-----| ========
|
|
======== ||:Tutor || |:::::| ========
|
|
======== |'-..................-'| |____o| ========
|
|
======== `"")----------------(""` ___________ ========
|
|
======== /::::::::::| |::::::::::\ \ no mouse \ ========
|
|
======== /:::========| |==hjkl==:::\ \ required \ ========
|
|
======== '""""""""""""' '""""""""""""' '""""""""""' ========
|
|
======== ========
|
|
=====================================================================
|
|
=====================================================================
|
|
|
|
What is Kickstart?
|
|
|
|
Kickstart.nvim is *not* a distribution.
|
|
|
|
Kickstart.nvim is a starting point for your own configuration.
|
|
The goal is that you can read every line of code, top-to-bottom, understand
|
|
what your configuration is doing, and modify it to suit your needs.
|
|
|
|
Once you've done that, you can start exploring, configuring and tinkering to
|
|
make Neovim your own! That might mean leaving kickstart just the way it is for a while
|
|
or immediately breaking it into modular pieces. It's up to you!
|
|
|
|
If you don't know anything about Lua, I recommend taking some time to read through
|
|
a guide. One possible example which will only take 10-15 minutes:
|
|
- https://learnxinyminutes.com/docs/lua/
|
|
|
|
After understanding a bit more about Lua, you can use `:help lua-guide` as a
|
|
reference for how Neovim integrates Lua.
|
|
- :help lua-guide
|
|
- (or HTML version): https://neovim.io/doc/user/lua-guide.html
|
|
|
|
Kickstart Guide:
|
|
|
|
TODO: The very first thing you should do is to run the command `:Tutor` in Neovim.
|
|
|
|
If you don't know what this means, type the following:
|
|
- <escape key>
|
|
- :
|
|
- Tutor
|
|
- <enter key>
|
|
|
|
(If you already know how the Neovim basics, you can skip this step)
|
|
|
|
Once you've completed that, you can continue working through **AND READING** the rest
|
|
of the kickstart init.lua
|
|
|
|
Next, run AND READ `:help`.
|
|
This will open up a help window with some basic information
|
|
about reading, navigating and searching the builtin help documentation.
|
|
|
|
This should be the first place you go to look when you're stuck or confused
|
|
with something. It's one of my favorite neovim features.
|
|
|
|
MOST IMPORTANTLY, we provide a keymap "<space>sh" to [s]earch the [h]elp documentation,
|
|
which is very useful when you're not sure exactly what you're looking for.
|
|
|
|
I have left several `:help X` comments throughout the init.lua
|
|
These are hints about where to find more information about the relevant settings,
|
|
plugins or neovim features used in kickstart.
|
|
|
|
NOTE: Look for lines like this
|
|
|
|
Throughout the file. These are for you, the reader, to help understand what is happening.
|
|
Feel free to delete them once you know what you're doing, but they should serve as a guide
|
|
for when you are first encountering a few different constructs in your nvim config.
|
|
|
|
If you experience any errors while trying to install kickstart, run `:checkhealth` for more info
|
|
|
|
I hope you enjoy your Neovim journey,
|
|
- TJ
|
|
|
|
P.S. You can delete this when you're done too. It's your config now! :)
|
|
--]]
|
|
|
|
-- Set <space> as the leader key
|
|
-- See `:help mapleader`
|
|
-- NOTE: Must happen before plugins are loaded (otherwise wrong leader will be used)
|
|
vim.g.mapleader = ' '
|
|
vim.g.maplocalleader = ' '
|
|
|
|
-- [[ Setting options ]]
|
|
require 'options'
|
|
|
|
-- [[ Basic Keymaps ]]
|
|
require 'keymaps'
|
|
|
|
-- [[ Install `lazy.nvim` plugin manager ]]
|
|
require 'lazy-bootstrap'
|
|
|
|
-- [[ Configure and install plugins ]]
|
|
require 'lazy-plugins'
|
|
|
|
-- The line beneath this is called `modeline`. See `:help modeline`
|
|
-- vim: ts=2 sts=2 sw=2 et
|