diff --git a/.gitignore b/.gitignore index 3c3629e..a78332b 100644 --- a/.gitignore +++ b/.gitignore @@ -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~ diff --git a/README.md b/README.md index e69de29..5c175b9 100644 --- a/README.md +++ b/README.md @@ -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 | +|:-------:|:-----:| +|  |  | diff --git a/assets/correct.png b/assets/correct.png new file mode 100644 index 0000000..2de0d51 Binary files /dev/null and b/assets/correct.png differ diff --git a/assets/incorrect.png b/assets/incorrect.png new file mode 100644 index 0000000..4e6650b Binary files /dev/null and b/assets/incorrect.png differ diff --git a/index.html b/index.html index 45791e9..fdf57b6 100644 --- a/index.html +++ b/index.html @@ -31,7 +31,10 @@
- {{INSTRUCTIONS HERE}} + See instructions