diff --git a/lua/cosmic/config/config-example.lua b/lua/cosmic/config/examples/config.lua similarity index 100% rename from lua/cosmic/config/config-example.lua rename to lua/cosmic/config/examples/config.lua diff --git a/lua/cosmic/config/editor-example.lua b/lua/cosmic/config/examples/editor.lua similarity index 100% rename from lua/cosmic/config/editor-example.lua rename to lua/cosmic/config/examples/editor.lua diff --git a/lua/cosmic/config/mappings-example.lua b/lua/cosmic/config/examples/mappings.lua similarity index 100% rename from lua/cosmic/config/mappings-example.lua rename to lua/cosmic/config/examples/mappings.lua diff --git a/lua/cosmic/config/plugins-example.lua b/lua/cosmic/config/examples/plugins.lua similarity index 100% rename from lua/cosmic/config/plugins-example.lua rename to lua/cosmic/config/examples/plugins.lua diff --git a/lua/cosmic/config/examples/readme.md b/lua/cosmic/config/examples/readme.md new file mode 100644 index 0000000..b638ce2 --- /dev/null +++ b/lua/cosmic/config/examples/readme.md @@ -0,0 +1,20 @@ +## Configuration + +There are four main configuraiton files that you may want to create. + +- cosmic/config/config.lua +- cosmic/config/editor.lua +- cosmic/config/mappings.lua +- cosmic/config/plugins.lua + +Please look at the examples in this directory in order to get started. + +#### Quick Start + +``` +# from project root +cp ./lua/cosmic/config/examples/config.lua ./lua/cosmic/config/config.lua +cp ./lua/cosmic/config/examples/editor.lua ./lua/cosmic/config/editor.lua +cp ./lua/cosmic/config/examples/mappings.lua ./lua/cosmic/config/mappings.lua +cp ./lua/cosmic/config/examples/plugins.lua ./lua/cosmic/config/plugins.lua +```