From f746682e93bfeb184e2e59b68326a3b4ce4284e9 Mon Sep 17 00:00:00 2001 From: Fausto Núñez Alberro Date: Sat, 16 Jan 2021 14:13:47 +0100 Subject: Document process in the README --- README.md | 29 ++++++++++++++++++++++++----- 1 file changed, 24 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 98611b7..17050da 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ +| 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. | +| --- | + # Base16 Vim -See the [Base16 repository](https://github.com/chriskempson/base16) for more information. -This theme was built with [Base16 Builder PHP](https://github.com/chriskempson/base16-builder-php). +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. @@ -35,13 +38,13 @@ Add the following to your `~/.vimrc` file and run `PlugInstall` in Vim. cd ~/.vim/colors git clone git://github.com/chriskempson/base16-vim.git base16 cp base16/colors/*.vim . - -## 256 colorspace + +## 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. 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. +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/chriskempson/base16-shell) repository. @@ -78,3 +81,19 @@ augroup on_change_colorschema autocmd ColorScheme * call s:base16_customize() augroup END ``` + +## Building +Dependencies: + +- Python, at least version 3.5 +- The `pybase16` command from [base16-builder-python](https://github.com/InspectorMustache/base16-builder-python) +- The `make` command + +``` +# Install dependencies (you probably already have pip/pip3 and make) +apt install build-essential # for make +pip3 install pybase16-builder + +# Build the packages +make +``` -- cgit v1.2.3