diff options
author | max397574 <[email protected]> | 2021-10-18 21:52:32 +0200 |
---|---|---|
committer | max397574 <[email protected]> | 2021-10-18 21:52:32 +0200 |
commit | ab3296ee85adbd4f7f208a5778d4ed6087a742b4 (patch) | |
tree | d973e6c6f6999638aeb84d3e3f378e42ec23cdc5 /readme.md | |
parent | bbe9b45857175599a7638e378f4f63074a553119 (diff) |
docs(readme): 📚started adding Customization
Diffstat (limited to 'readme.md')
-rw-r--r-- | readme.md | 45 |
1 files changed, 44 insertions, 1 deletions
@@ -7,16 +7,59 @@ * Fully customizable * Themes +* Easy Customization with building blocks 📦Installation ------------ Use your favourite package manager and call setup function. +For the default setup telescope.nvim is a dependency. ```lua +-- lua and packer.nvim + +use { + "max397574/startup.nvim", + requires = {"nvim-telescope/telescope.nvim", "nvim-lua/plenary.nvim"} + config = function() + require"startup".setup() + end +} ``` ⚙️Customization ------------- -Call the setup function with your configs +<!-- NOTE: --> +<!-- ???See wiki --> + +Call the setup function with your configurations + +It is recommended to use a file in the setup function. This can be done like this: ```lua +-- lua and packer.nvim + +use { + "max397574/startup.nvim", + requires = {"nvim-telescope/telescope.nvim", "nvim-lua/plenary.nvim"} + config = function() + require"starup".setup(require"configs.startup") -- recommended to use a file for this + end +} ``` + +Here the file would be located at `/lua/configs/startup.lua`. +The file has to return settings. + +For one of the default themes this can be done like this: (startify theme) + +```lua +local settings = require"startup.themes.startify" + +return settings +``` +<!-- NOTE: update this --> +These themes are currently available: + +* Default +* Startify +<!-- TODO: evil-startup theme --> +<!-- * Evil-startup --> |