From 16c4757457e469771a9c0eb5718f785057ed23da Mon Sep 17 00:00:00 2001 From: Fausto Núñez Alberro Date: Tue, 26 Jan 2021 23:17:57 +0100 Subject: Move the PR template to a correct location --- .github/pull_request_template.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .github/pull_request_template.md (limited to '.github/pull_request_template.md') diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..056da93 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,11 @@ +# Description + + + +Fixes #ISSUE_NUMBER + +# Checklist + +- [ ] I have built the project after my changes following [the build instructions](https://github.com/fnune/base16-vim#building) using `make build` +- [ ] I have confirmed that my changes produce no regressions after building +- [ ] I have pushed the built files to this pull request as a separate commit -- cgit v1.2.3 From 67c41be7820ef94b45ec31290e8b875a1d7172bf Mon Sep 17 00:00:00 2001 From: Fausto Núñez Alberro Date: Tue, 26 Jan 2021 23:21:01 +0100 Subject: Clarify how to add built files in PRs --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to '.github/pull_request_template.md') diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 056da93..d8e1e7b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -8,4 +8,4 @@ Fixes #ISSUE_NUMBER - [ ] I have built the project after my changes following [the build instructions](https://github.com/fnune/base16-vim#building) using `make build` - [ ] I have confirmed that my changes produce no regressions after building -- [ ] I have pushed the built files to this pull request as a separate commit +- [ ] I have pushed the built files to this pull request -- cgit v1.2.3 From 71ca2d57c947e2ff8f4e2d201e81380d11e71bbf Mon Sep 17 00:00:00 2001 From: Fausto Núñez Alberro Date: Sat, 6 Feb 2021 01:55:38 +0100 Subject: Fix the PR check script --- .github/pull_request_template.md | 2 +- .github/workflows/pr.yml | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) (limited to '.github/pull_request_template.md') diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d8e1e7b..0263490 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,6 +6,6 @@ Fixes #ISSUE_NUMBER # Checklist -- [ ] I have built the project after my changes following [the build instructions](https://github.com/fnune/base16-vim#building) using `make build` +- [ ] I have built the project after my changes following [the build instructions](https://github.com/fnune/base16-vim#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/.github/workflows/pr.yml b/.github/workflows/pr.yml index f5e8385..b916f97 100644 --- a/.github/workflows/pr.yml +++ b/.github/workflows/pr.yml @@ -17,7 +17,7 @@ jobs: run: pip install pybase16-builder - name: Fetch the repository code uses: actions/checkout@v2 - - name: Run make build - run: make build + - name: Run make + run: make - name: Check if there are changes run: git diff --exit-code -- cgit v1.2.3 From 96cb6215c8eda1d20bc04454b3ee36aa504e639c Mon Sep 17 00:00:00 2001 From: Fausto Núñez Alberro Date: Sat, 18 Sep 2021 16:55:16 +0200 Subject: Add CONTRIBUTING.md --- .github/pull_request_template.md | 4 +++- CONTRIBUTING.md | 38 ++++++++++++++++++++++++++++++++++++++ README.md | 18 +++--------------- 3 files changed, 44 insertions(+), 16 deletions(-) create mode 100644 CONTRIBUTING.md (limited to '.github/pull_request_template.md') diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 0263490..d1e53d9 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,6 +6,8 @@ Fixes #ISSUE_NUMBER # Checklist -- [ ] I have built the project after my changes following [the build instructions](https://github.com/fnune/base16-vim#building) using `make` +- [ ] I have built the project after my changes following [the build + instructions](https://github.com/fnune/base16-vim/blob/master/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/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b5fb1a3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +# Contributing + +## 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 + +For example on a Debian-based distribution: + +``` +# Install dependencies (you probably already have pip/pip3 and make) +apt install build-essential # for make +pip3 install pybase16-builder + +# Build the packages +make +``` + +## Submitting a PR + +After you've installed the build dependencies, and before you submit your PR: + +- Run `make` after you've made your changes. This will build all the themes + based on the changes you've made. +- Make sure to commit the changes from `make` and include them in your PR. +- Please abide by what's requested in the [PR + template](/.github/pull_request_template.md). + +## Submitting an issue + +Please follow the instructions in the issue templates: + +- [Issue template for bug reports](/.github/ISSUE_TEMPLATE/bug_report.md) +- [Issue template for feature requests](/.github/ISSUE_TEMPLATE/feature_request.md) diff --git a/README.md b/README.md index 12849a2..e9b2b04 100644 --- a/README.md +++ b/README.md @@ -95,18 +95,6 @@ augroup on_change_colorschema 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 -``` +## Contributing +See [`CONTRIBUTING.md`](/CONTRIBUTING.md), which contains building and +contributing instructions. -- cgit v1.2.3 From c5a45f4c2681b7273bad0648dbeea189b540e80c Mon Sep 17 00:00:00 2001 From: Jamy Date: Wed, 8 Jun 2022 18:14:30 +0200 Subject: 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 --- .github/pull_request_template.md | 2 +- README.md | 59 ++++++++++++++++++++++++++-------------- 2 files changed, 40 insertions(+), 21 deletions(-) (limited to '.github/pull_request_template.md') 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. -- cgit v1.2.3