diff --git a/.DS_Store b/.DS_Store index 00244ca..9a7ec00 100644 Binary files a/.DS_Store and b/.DS_Store differ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ba0f648 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2020 embark-theme + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..051c560 --- /dev/null +++ b/README.md @@ -0,0 +1,99 @@ +
+

embark-lua.nvim

+
+ +

An ambitious Vim theme.

+ +

"Man cannot discover new oceans unless he has the courage to lose sight of the shore. - Andre Gide"

+ +
+ screenshot +
+ +## About + +This is a rewrite of original theme [embark](https://github.com/embark-theme/vim) in lua, All credits for color palette and idea should goes to the author. +Rewriting in lua brings better support for treesitter, lualine and other commonly used nvim plugins. + +## Getting Started + +First install using your plugin manager. Rename package to embark using your plugin manager's built in facilities to do so. + +### lazy.nvim + +```lua +return { + "genzyy/embark-lua.nvim", + name = "embark", +} +``` + +### packer.nvim +```lua +use { 'genzyy/embark-lua.nvim', as = 'embark' } +``` + +### vim-plug +```vim +Plug 'genzyy/embark-lua.nvim', { 'as': 'embark', 'branch': 'main' } +``` + +Then set embark as colorscheme. + +Vimscript + +```vim +colorscheme embark +``` + +Lua for neovim + +```lua +vim.cmd('colorscheme embark') +``` + +For packer users the colorscheme can be placed in the config callback. + +```lua +use { + 'genzyy/embark-lua.nvim', + as = 'embark', + config = function() + vim.cmd('colorscheme embark') + end +} +``` + +### Lightline support + +A lightline theme is also available. Just set your colorscheme to embark. + +```vim +let g:lightline = { + \ 'colorscheme': 'embark', + \ } +``` + +### Airline support + +Airline should just pick up on theme automatically, but if there is an issue with this it can be set manually. +`let g:airline_theme = 'embark'` + +### Lualine support + +Lualine should pick up the theme with the `auto` setting, or you can set it manually. + +```lua +require('lualine').setup { + options = { + theme = 'embark', + } +} +``` + + +### Todo + +- [ ] user configuration. +- [ ] support for other nvim plugins. +- [ ] light variant. diff --git a/assets/screenshot.png b/assets/screenshot.png new file mode 100644 index 0000000..ef7ac22 Binary files /dev/null and b/assets/screenshot.png differ