Skip to content

Commit

Permalink
some README changes
Browse files Browse the repository at this point in the history
  • Loading branch information
danilo-augusto committed Aug 29, 2019
1 parent 6a1d94e commit 54cb8c3
Showing 1 changed file with 21 additions and 23 deletions.
44 changes: 21 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,55 +2,53 @@

[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MVSBJ7JKSVGZ4&source=url)

Vim adaptation of the [Afterglow](https://github.com/YabataDesign/afterglow-theme) theme from Sublime Text 2/3.
🎨 Vim adaptation of the [Afterglow](https://github.com/YabataDesign/afterglow-theme) theme from Sublime Text 2/3.

Airline scheme included.
🎁 Airline scheme included.

## Setup

- To enable it, simply add `colorscheme afterglow` (not ~~vim-afterglow~~) to your `~/.vimrc` after having installed the plugin (manually or by using a package manager).
To enable it, simply add `colorscheme afterglow` (not ~~vim-afterglow~~) to your `~/.vimrc` after having installed the plugin (manually or by using a package manager).

- Airline theme should be updated accordingly, but can be explicitly specified by using `let g:airline_theme='afterglow'`.
> Airline theme should be updated accordingly, but can be explicitly specified by using `let g:airline_theme='afterglow'`.
## Options

To further customize Afterglow, you can currently use the following options **before** setting the color scheme on your
vimrc:
To further customize Afterglow, you can use the following options **before** setting the color scheme on your
`vimrc` (or `init.vim` if using NeoVim):

- Inherit background: `let g:afterglow_inherit_background=1` (default: 0)
- Blackout: `let g:afterglow_blackout=1 (default: 0)`

Use this option if you want the background color to play nicely with the program (e.g. gVim, iTerm etc.) in which vim is used.
β˜€οΈ Use this option if you need more contrast, such as when working in an office where open windows are just behind you, causing glare on your screen.

- Black background: `let g:afterglow_blackout=1` (default: 0)
> This option has no effect if `g:afterglow_inherit_background` is also set.
β˜€οΈ Use this option if you need more contrast, such as working in an office where open windows cause glare on your screen.
- Italicize comments: `let g:afterglow_italic_comments=1 (default: 0)`

NB: This option has no effect if `g:afterglow_inherit_background` is also set!
πŸ“– Helps visual grepping and quickly differentiating source code and comments when skimming through files.

- Italicize comments: `let g:afterglow_italic_comments=1` (default: 0)
> If using a terminal emulator (iTerm, Alacritty, Terminator...), check if it correctly supports italics. Evidently your chosen font type should have an italics variety too. In case of problems please check these two common scenarios before opening an issue concerning *italics*.
πŸ“– Helps visual grepping and quickly differentiating source code and comments when skimming through files.
- Inherit background: `let g:afterglow_inherit_background=1 (default: 0)`

⚠️ Using italics needs a terminal emulator (e.g. iTerm in MacOS) and a font supporting it.
Use this option if you want the background color to play nicely with the program (e.g. gVim, iTerm etc.) in which vim is used. It may be useful when instantiating vim inside Tmux.

## Screenshots

### Python
<img width="700" alt="python" src="https://cloud.githubusercontent.com/assets/8104631/23351157/c9c22072-fcbf-11e6-8c58-a04e0838ce5c.png">
<img width="800" alt="python" src="https://cloud.githubusercontent.com/assets/8104631/23351157/c9c22072-fcbf-11e6-8c58-a04e0838ce5c.png">

### LaTeX
<img width="700" alt="latex" src="https://cloud.githubusercontent.com/assets/8104631/23351155/c9b3d7c4-fcbf-11e6-8229-0c50707a98be.png">
### Ruby
<img width="800" alt="ruby" src="https://cloud.githubusercontent.com/assets/8104631/23351154/c99cf856-fcbf-11e6-88f6-857568a7ed8d.png">

### HTML
<img width="700" alt="html" src="https://cloud.githubusercontent.com/assets/8104631/23351156/c9bd9318-fcbf-11e6-9f49-0dc661c5aad5.png">
<img width="800" alt="html" src="https://cloud.githubusercontent.com/assets/8104631/23351156/c9bd9318-fcbf-11e6-9f49-0dc661c5aad5.png">

### Ruby
<img width="700" alt="ruby" src="https://cloud.githubusercontent.com/assets/8104631/23351154/c99cf856-fcbf-11e6-88f6-857568a7ed8d.png">
<!--### LaTeX-->
<!--<img width="800" alt="latex" src="https://cloud.githubusercontent.com/assets/8104631/23351155/c9b3d7c4-fcbf-11e6-8229-0c50707a98be.png">-->

## Donate

Don't forget to give back to the Open Source community in some way (not necessarily me). 😊

And if you liked this project, feel free to pay me a cup of coffee! β˜•οΈ ❀️ πŸ‘‡
And if you liked this project, feel free to pay me a cup of coffee! 😊 β˜•οΈ ❀️ πŸ‘‡

[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MVSBJ7JKSVGZ4&source=url)

0 comments on commit 54cb8c3

Please sign in to comment.