|
1 | | ---[[ |
2 | | - |
3 | | -===================================================================== |
4 | | -==================== READ THIS BEFORE CONTINUING ==================== |
5 | | -===================================================================== |
6 | | -======== .-----. ======== |
7 | | -======== .----------------------. | === | ======== |
8 | | -======== |.-""""""""""""""""""-.| |-----| ======== |
9 | | -======== || || | === | ======== |
10 | | -======== || KICKSTART.NVIM || |-----| ======== |
11 | | -======== || || | === | ======== |
12 | | -======== || || |-----| ======== |
13 | | -======== ||:Tutor || |:::::| ======== |
14 | | -======== |'-..................-'| |____o| ======== |
15 | | -======== `"")----------------(""` ___________ ======== |
16 | | -======== /::::::::::| |::::::::::\ \ no mouse \ ======== |
17 | | -======== /:::========| |==hjkl==:::\ \ required \ ======== |
18 | | -======== '""""""""""""' '""""""""""""' '""""""""""' ======== |
19 | | -======== ======== |
20 | | -===================================================================== |
21 | | -===================================================================== |
22 | | -
|
23 | | -What is Kickstart? |
24 | | -
|
25 | | - Kickstart.nvim is *not* a distribution. |
26 | | -
|
27 | | - Kickstart.nvim is a starting point for your own configuration. |
28 | | - The goal is that you can read every line of code, top-to-bottom, understand |
29 | | - what your configuration is doing, and modify it to suit your needs. |
30 | | -
|
31 | | - Once you've done that, you can start exploring, configuring and tinkering to |
32 | | - make Neovim your own! That might mean leaving Kickstart just the way it is for a while |
33 | | - or immediately breaking it into modular pieces. It's up to you! |
34 | | -
|
35 | | - If you don't know anything about Lua, I recommend taking some time to read through |
36 | | - a guide. One possible example which will only take 10-15 minutes: |
37 | | - - https://learnxinyminutes.com/docs/lua/ |
38 | | -
|
39 | | - After understanding a bit more about Lua, you can use `:help lua-guide` as a |
40 | | - reference for how Neovim integrates Lua. |
41 | | - - :help lua-guide |
42 | | - - (or HTML version): https://neovim.io/doc/user/lua-guide.html |
43 | | -
|
44 | | -Kickstart Guide: |
45 | | -
|
46 | | - TODO: The very first thing you should do is to run the command `:Tutor` in Neovim. |
47 | | -
|
48 | | - Once you've completed that, you can continue working through **AND READING** the rest |
49 | | - of the kickstart init.lua. |
50 | | -
|
51 | | - Next, run AND READ `:help`. |
52 | | - This will open up a help window with some basic information |
53 | | - about reading, navigating and searching the builtin help documentation. |
54 | | -
|
55 | | - This should be the first place you go to look when you're stuck or confused |
56 | | - with something. It's one of my favorite Neovim features. |
57 | | -
|
58 | | - MOST IMPORTANTLY, we provide a keymap "<space>sh" to [s]earch the [h]elp documentation, |
59 | | - which is very useful when you're not exactly sure of what you're looking for. |
60 | | -
|
61 | | - I have left several `:help X` comments throughout the init.lua |
62 | | - These are hints about where to find more information about the relevant settings, |
63 | | - plugins or Neovim features used in Kickstart. |
64 | | -
|
65 | | - NOTE: Look for lines like this |
66 | | -
|
67 | | - Throughout the file. These are for you, the reader, to help you understand what is happening. |
68 | | - Feel free to delete them once you know what you're doing, but they should serve as a guide |
69 | | - for when you are first encountering a few different constructs in your Neovim config. |
70 | | -
|
71 | | -If you experience any errors while trying to install kickstart, run `:checkhealth` for more info. |
72 | | -
|
73 | | -I hope you enjoy your Neovim journey, |
74 | | -- TJ |
75 | | -
|
76 | | ---]] |
77 | | - |
78 | 1 | -- Set <space> as the leader key |
79 | 2 | -- See `:help mapleader` |
80 | 3 | -- NOTE: Must happen before plugins are loaded (otherwise wrong leader will be used) |
|
0 commit comments