Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,23 @@
node_modules

## Vim working files

# Swap
[._]*.s[a-v][a-z]
!*.svg # comment out if you don't need vector files
[._]*.sw[a-p]
[._]s[a-rt-v][a-z]
[._]ss[a-gi-z]
[._]sw[a-p]

# Session
Session.vim
Sessionx.vim

# Temporary
.netrwhist
*~
# Auto-generated tag files
tags
# Persistent undo
[._]*.un~
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Installation

## Preparing for 256-color theme

This theme utilizes the ability of modern terminals to show 256 colors, so before you can proceed, make sure your terminal and terminal emulator support 256-color mode. After that, head to your vim configuration file `~/.vimrc`...
```vim
" add the following line to your config
set termguicolors
" this is a new setting from newer vesion,
" so for older version consider googling
```
... now you should be ready to go and install the theme.

## Theme

If you are using any of the package managers just add this repo as a plugin. Vundle for example:
```vim
Plugin 'maficious/vim'
```
Alternatively you can install this theme manually either by downloading this repo as zip and copying the contents of `/colors/dank-neon.vim` into your vim folder (`~/.vim`) or copying everything from `/colors/dank-neon.vim` into created by yourself file in `~/.vim/colors/`.

# Check

You can refer to following screenshots if you are not sure if it was installed correctly:

| Correct | Wrong |
|:-------:|:-----:|
| ![Correct](/assets/correct.png) | ![Wrong](/assets/incorrect.png) |
Binary file added assets/correct.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/incorrect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 4 additions & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,10 @@ <h1 class="orange">a danker, more neon theme for Vim</h1>
<img src="assets/vim.png" class="img-responsive" />
<h2 class="theme-title">How to install Dank Neon for Vim</h2>
<p>
{{INSTRUCTIONS HERE}}
<a href="https://github.com/DankNeon/vim#installation"
aria-label="See instructions for installing DankNeon theme for Vim on GitHub"
alt="Installation instructions"
>See instructions</a>
</p>
</main>
</body>
Expand Down