aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJamy <jamy@jamygolden.com>2022-06-08 18:14:30 +0200
committerGitHub <noreply@github.com>2022-06-08 18:14:30 +0200
commitc5a45f4c2681b7273bad0648dbeea189b540e80c (patch)
tree80697b19a86b40fb69f0e3127a5e5e9fb87ac231
parent18656ced6196dca7b4df47fe5ddec48c7b5819bd (diff)
Update readme (#57)
* Update readme formatting - Remove mention of the repo being a fork - Standardise formattin in document - Add syntax highlighting to code snippets * Add manual installation instructions for neovim * Remove specific mention of iTerm2 and link to base16 project lists * Change base16 repo links to base16-project
-rw-r--r--.github/pull_request_template.md2
-rw-r--r--README.md59
2 files changed, 40 insertions, 21 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index d1e53d9..0838e1d 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -7,7 +7,7 @@ Fixes #ISSUE_NUMBER
# Checklist
- [ ] I have built the project after my changes following [the build
- instructions](https://github.com/fnune/base16-vim/blob/master/CONTRIBUTING.md#building)
+ instructions](https://github.com/base16-project/base16-vim/blob/main/CONTRIBUTING.md#building)
using `make`
- [ ] I have confirmed that my changes produce no regressions after building
- [ ] I have pushed the built files to this pull request
diff --git a/README.md b/README.md
index e9b2b04..15c681d 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,10 @@
-| This is a fork of [chriskempson](https://github.com/chriskempson)'s [base16-vim](https://github.com/chriskempson/base16-vim) which refreshes and commits new themes weekly automatically and has a documented build process. |
-| :-- |
-| Development has continued beyond the automation of the repository since the moment of the fork. See [the full diff here](https://github.com/fnune/base16-vim/compare/c8a7da6...HEAD). |
-
# Base16 Vim
-See the [Base16 repository](https://github.com/chriskempson/base16) for more information.
+
This theme was built with [base16-builder-python](https://github.com/InspectorMustache/base16-builder-python).
Supports graphical Vim and console Vim.
-Over [70 themes](https://github.com/chriskempson/base16-schemes-source/blob/master/list.yaml) plus light/dark variations are available. Here are some of my favorites:
+Over [70 themes](https://github.com/base16-project/base16-schemes) plus light/dark variations are available. Here are some of our favorites:
The `classic-dark` theme:
@@ -23,44 +19,63 @@ The `onedark` theme:
![base16-vim onedark](/screenshots/base16-vim-screenshot-onedark.png)
## Terminal Themes
-For terminal Vim (non-gui) please ensure you are using a base16 terminal theme.
-* [iTerm2](https://github.com/chriskempson/base16-iterm2)
+For terminal Vim (non-gui) please ensure you are using a base16 terminal theme. Have a look at the list of [official](https://github.com/base16-project/base16#official-templates) and [unofficial](https://github.com/base16-project/base16#unofficial-templates) themes for your terminal of choice.
## Installation
Add `colorscheme base16-default-dark` to your `~/.vimrc`.
### Vundle
+
Add the following to your `~/.vimrc` file and run `PluginInstall` in Vim.
- Plugin 'fnune/base16-vim'
+```vim
+Plugin 'base16-project/base16-vim'
+```
### vim-plug
+
Add the following to your `~/.vimrc` file and run `PlugInstall` in Vim.
- Plug 'fnune/base16-vim'
+```vim
+Plug 'base16-project/base16-vim'
+```
### Pathogen
- cd ~/.vim/bundle
- git clone https://github.com/fnune/base16-vim.git
+```bash
+cd ~/.vim/bundle
+git clone https://github.com/base16-project/base16-vim.git
+```
### Manual
- cd ~/.vim/colors
- git clone git://github.com/fnune/base16-vim.git base16
- cp base16/colors/*.vim .
+```bash
+cd ~/.vim/colors
+git clone git://github.com/base16-project/base16-vim.git base16
+cp base16/colors/*.vim .
+```
+
+### Manual neovim
+
+```bash
+cd ~/.config/nvim/colors
+git clone git://github.com/base16-project/base16-vim.git base16
+cp base16/colors/*.vim .
+```
## 256 colorspace
-If using a Base16 terminal theme designed to keep the 16 ANSI colors intact (a "256" variation) **and** have sucessfully modified your 256 colorspace with [base16-shell](https://github.com/chriskempson/base16-shell) you'll need to add the following to your `~/.vimrc` **before** the colorsheme declaration.
+
+If using a Base16 terminal theme designed to keep the 16 ANSI colors intact (a "256" variation) **and** have sucessfully modified your 256 colorspace with [base16-shell](https://github.com/base16-project/base16-shell) you'll need to add the following to your `~/.vimrc` **before** the colorsheme declaration.
let base16colorspace=256 " Access colors present in 256 colorspace
This will cause vim to access the colours in the modified 256 colorspace. Please **do not** enable this simply because you have a 256 color terminal as this will cause colors to be displayed incorrectly.
## Troubleshooting
-There is a script to help troubleshoot colour issues called `colortest` available in the [Base16 Shell](https://github.com/fnune/base16-shell) repository.
+
+There is a script to help troubleshoot colour issues called `colortest` available in the [Base16 Shell](https://github.com/base16-project/base16-shell) repository.
If you are using a ISO-8613-3 compatible terminal (
[vim docs](https://github.com/vim/vim/blob/23c1b2b018c8121ca5fcc247e37966428bf8ca66/runtime/doc/options.txt#L7876),
@@ -72,16 +87,19 @@ set termguicolors
```
### Green line numbers
-![green line numbers screenshot](https://raw.github.com/chriskempson/base16-vim/master/without-base16colorspace-256-with-256-terminal-theme.png)
+
+![green line numbers screenshot](https://raw.github.com/base16-project/base16-vim/main/without-base16colorspace-256-with-256-terminal-theme.png)
If your Vim looks like the above image you are using a 256 terminal theme without setting `let base16colorspace=256` in your `~/.vimrc`. Either set `let base16colorspace=256` in your `~/.vimrc` or use a non 256 terminal theme.
### Blue line numbers
-![blue line numbers screenshot](https://raw.github.com/chriskempson/base16-vim/master/with-base16colorspace-256-without-base16-shell.png)
-If your Vim looks like the above image you are setting `let base16colorspace=256` in your `~/.vimrc` but either not running [Base16 Shell](https://github.com/fnune/base16-shell) or [Base16 Shell](https://github.com/fnune/base16-shell) is not working for your terminal. Either ensure [Base16 Shell](https://github.com/fnune/base16-shell) is working by running the `colortest` available in the [Base16 Shell](https://github.com/fnune/base16-shell) repository or not setting `let base16colorspace=256` in your `~/.vimrc`.
+![blue line numbers screenshot](https://raw.github.com/base16-project/base16-vim/main/with-base16colorspace-256-without-base16-shell.png)
+
+If your Vim looks like the above image you are setting `let base16colorspace=256` in your `~/.vimrc` but either not running [Base16 Shell](https://github.com/base16-project/base16-shell) or [Base16 Shell](https://github.com/base16-project/base16-shell) is not working for your terminal. Either ensure [Base16 Shell](https://github.com/base16-project/base16-shell) is working by running the `colortest` available in the [Base16 Shell](https://github.com/base16-project/base16-shell) repository or not setting `let base16colorspace=256` in your `~/.vimrc`.
## Customization
+
If you want to do some local customization, you can add something like this to your `~/.vimrc`:
```vim
@@ -96,5 +114,6 @@ augroup END
```
## Contributing
+
See [`CONTRIBUTING.md`](/CONTRIBUTING.md), which contains building and
contributing instructions.