feat(config): add readme and clean up dir

This commit is contained in:
Matt Leong 2021-11-07 07:50:18 -08:00
parent 56e1a36ac7
commit 02cc3131fe
5 changed files with 20 additions and 0 deletions

View file

@ -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
```