Skip to content

Commit

Permalink
Updated contributing file
Browse files Browse the repository at this point in the history
  • Loading branch information
Unthrottled committed Jan 4, 2022
1 parent 9824a65 commit 9445777
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ the [installation instructions](https://github.com/doki-theme/doki-theme-vim#ins

- Yarn package manager
- Node 14
- [HighLinkTrace](https://github.com/gerw/vim-HiLinkTrace)

## Initial Setup

Expand Down Expand Up @@ -77,6 +78,38 @@ To accomplish this, just run this command in the `masterThemes` directory.
yarn
```

**Install Helpful Plugins**

[HiLinkTrace](https://github.com/gerw/vim-HiLinkTrace) is a handy plugin that allows you to look up the syntax highlighting in an open file with syntax highlighting on.

- Create a place to install the plugin

```shell
mkdir -p ~/.vim/pack/vendor/start
```

- Clone the repository into the new destination

```shell
git clone --depth 1 [email protected]:gerw/vim-HiLinkTrace.git ~/.vim/pack/vendor/start/hiLinkTrace
```

- Enable the setting in your `~/.vimrc`

```vimscript
filetype plugin on
syntax on
colorscheme zero_two_light " Best Girl
:set hls
nnoremap <F8> :HLT<CR> " Allows you to use F8 to view the source highlightings
nnoremap <F10> :colorscheme zero_two_light<CR> " Convience Shortcut to F10 that sets a theme
```

![Dev Setup](./assets/screenshots/dev_vim_setup.png)

> I pressed F8 where the cursor is and it shows me that it is scoped to `vimBracket` from `vimBracket->Delimiter->Special`

### Set up build source

Navigate to the root of the `buildSource` directory and run the following command.
Expand Down Expand Up @@ -112,7 +145,7 @@ the Doki Theme Suite.

### Vim specifics

There are a _bunch_ of templates that compose the assets of this plugin.
There are a few templates that compose the assets of this plugin.

They can be found in `buildSrc/assets/templates`

Expand Down
Binary file added assets/screenshots/dev_vim_setup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9445777

Please sign in to comment.