aboutsummaryrefslogtreecommitdiff
path: root/bore.vim/README.md
diff options
context:
space:
mode:
authorEthan Morgan <ethan@gweithio.com>2026-02-14 16:40:16 +0000
committerEthan Morgan <ethan@gweithio.com>2026-02-14 16:40:16 +0000
commitb94eefa6b58f274bb61db4e792105c3959cf2022 (patch)
tree3d2896fb46ebc769e4fea8cf4f02ce3104e1f974 /bore.vim/README.md
init dotfiles and stuffHEADmaster
Diffstat (limited to 'bore.vim/README.md')
-rw-r--r--bore.vim/README.md74
1 files changed, 74 insertions, 0 deletions
diff --git a/bore.vim/README.md b/bore.vim/README.md
new file mode 100644
index 0000000..e861d73
--- /dev/null
+++ b/bore.vim/README.md
@@ -0,0 +1,74 @@
+# Bore
+
+<p align="center">
+ <img src="./images/screenshot.png" alt="Screenshot">
+</p>
+
+<p align="center">
+ <em>Bore is a modern and minimal NeoVim dark theme with bright colors. The theme is based on the great theme <a href="https://github.com/AhmedAbdulrahman/aylin.vim">Aylin Theme</a>. See Credits for a detailed lineage.</em>
+</p>
+
+Note: This relies heavily on Treesitter and will not look exactly as presented without it. Sorry
+
+## Installation
+
+You can install `bore.vim` with whatever package manager you use. For example:
+
+- [Pathogen][vimpathogen]
+- [Vundle][vundle]
+- [NeoBundle][neobundle]
+- [VIM Plug][vimplug]
+
+For example:
+
+- Pathogen
+ - `git clone https://github.com/gweithio/vim-bore.git ~/.vim/bundle/vim-bore`
+- Vundle
+ - Add `Plugin 'gweithio/vim-bore'` to your .vimrc and run `:PluginInstall`
+- NeoBundle
+ - Add `NeoBundle 'gweithio/vim-bore'` to your .vimrc and run `:NeoBundleInstall`
+- vim-plug
+ - Add `Plug 'gweithio/vim-bore'` to your .vimrc and run `:PlugInstall`
+- Vim-8
+ - `git clone https://github.com/gweithio/vim-bore.git ~/.vim/pack/default/start/vim-bore`
+
+> > If you don't use a plugin manager just copy the content of vim/colors/ to ~/.vim/colors.
+
+## Usage
+
+In your Vim `(~/.vimrc)` or Neovim `(.config/nvim/init.vim)` configuration, place the following two lines:
+
+```vim
+set background=dark
+colorscheme bore
+```
+
+### True Colors
+
+To provide the best user experience possible, I recommend enabling true colors. To experience the blissfulness of your editor's true colors, place this in your `.vimrc` or `~/.config/nvim/init.vim` file:
+
+```vim
+if (has("nvim"))
+ "For Neovim 0.1.3 and 0.1.4 < https://github.com/neovim/neovim/pull/2198 >
+ let $NVIM_TUI_ENABLE_TRUE_COLOR=1
+endif
+
+"For Neovim > 0.1.5 and Vim > patch 7.4.1799 < https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162 >
+"Based on Vim patch 7.4.1770 (`guicolors` option) < https://github.com/vim/vim/commit/8a633e3427b47286869aa4b96f2bfc1fe65b25cd >
+" < https://github.com/neovim/neovim/wiki/Following-HEAD#20160511 >
+if (has("termguicolors"))
+ set termguicolors
+endif
+```
+
+## Contributing
+
+All forms of contribution are welcome: bug reports, bug fixes, pull requests and simple suggestions. Thanks!
+
+## Credits
+
+Credit goes to the [Aylin]. I ended up changing colors and their mappings.
+
+## License
+
+MIT License © 2022 Ethan Morgan. See [LICENSE.txt](./LICENSE.txt) for more information.