aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/kickstart.txt24
-rw-r--r--doc/tags3
2 files changed, 27 insertions, 0 deletions
diff --git a/doc/kickstart.txt b/doc/kickstart.txt
new file mode 100644
index 0000000..cb87ac3
--- /dev/null
+++ b/doc/kickstart.txt
@@ -0,0 +1,24 @@
+================================================================================
+INTRODUCTION *kickstart.nvim*
+
+Kickstart.nvim is a project to help you get started on your neovim journey.
+
+ *kickstart-is-not*
+It is not:
+- Complete framework for every plugin under the sun
+- Place to add every plugin that could ever be useful
+
+ *kickstart-is*
+It is:
+- Somewhere that has a good start for the most common "IDE" type features:
+ - autocompletion
+ - goto-definition
+ - find references
+ - fuzzy finding
+ - and hinting at what more can be done :)
+- A place to _kickstart_ your journey.
+ - You should fork this project and use/modify it so that it matches your
+ style and preferences. If you don't want to do that, there are probably
+ other projects that would fit much better for you (and that's great!)!
+
+ vim:tw=78:ts=8:ft=help:norl:
diff --git a/doc/tags b/doc/tags
new file mode 100644
index 0000000..687ae77
--- /dev/null
+++ b/doc/tags
@@ -0,0 +1,3 @@
+kickstart-is kickstart.txt /*kickstart-is*
+kickstart-is-not kickstart.txt /*kickstart-is-not*
+kickstart.nvim kickstart.txt /*kickstart.nvim*