Incorporate the changes done for the release 0.2.0

It mainly incorporates modifications of the README.md and CHANGELOG.md
files.
This commit is contained in:
Ludovic Koenig
2019-03-09 19:22:58 +01:00
3 changed files with 56 additions and 16 deletions
+32 -10
View File
@@ -2,7 +2,28 @@
All notable changes to this project will be documented in this file. This All notable changes to this project will be documented in this file. This
project adheres to [Semantic Versioning]. project adheres to [Semantic Versioning].
# [Unreleased] ## [0.2.0] - 2019-03-09
### Added
- Add support for 256-colors terminal.
+ If 8-bits colors are required, the following must be used in `.vimrc`:
```vim
set termguicolors
colorscheme odyssey
```
+ If 24-bits colors are required, the following must be used `.vimrc`:
```vim
set t_Co=256
colorscheme odyssey
```
- Add the highlight for the default syntax group names Cursor and lCursor.
Those are basically the opposite of Normal.
### Changed ### Changed
@@ -12,10 +33,10 @@ project adheres to [Semantic Versioning].
The violet color is removed, and the yellow-green color is added. The violet color is removed, and the yellow-green color is added.
| Color | Name | Main usage | Hue | Saturation | Value | | Color | Name | Main usage | Hue | Saturation | Value |
| ------- | ---------------- | ----------------- | --- | ---------- | ----- | | ----------- | ---------- | ----------------- | --- | ---------- | ----- |
| #8ab362 | yellow-green | Constant | 110 | 45 | 70 | | #add590 | yellow | Constant | 95 | 45 | 70 |
| #6270b3 | ~~violet~~ | Constant | 230 | 45 | 70 | | ~~#6270b3~~ | ~~violet~~ | Constant | 230 | 45 | 70 |
- The highlight for MatchParen has been modified. In fact, when the cursor is - The highlight for MatchParen has been modified. In fact, when the cursor is
over a parenthese, a bracket, a brace, and so on, the matching element turns over a parenthese, a bracket, a brace, and so on, the matching element turns
@@ -54,14 +75,15 @@ project adheres to [Semantic Versioning].
and it must be set on. In other words, the color scheme must be used as and it must be set on. In other words, the color scheme must be used as
followed. followed.
```vim ```vim
set termguicolors set termguicolors
colorscheme odyssey colorscheme odyssey
``` ```
+ A ISO-8613-3 compatible terminal is required. + A ISO-8613-3 compatible terminal is required.
+ Otherwise, a GUI version of Vim must be used. + Otherwise, a GUI version of Vim must be used.
[Unreleased]: https://github.com/ludokng/vim-odyssey/compare/0.1.0...HEAD [Unreleased]: https://github.com/ludokng/vim-odyssey/compare/0.2.0...HEAD
[0.2.0]: https://github.com/ludokng/vim-odyssey/compare/0.1.0...0.2.0
[Semantic Versioning]: https://semver.org/spec/v2.0.0.html [Semantic Versioning]: https://semver.org/spec/v2.0.0.html
+22 -4
View File
@@ -27,10 +27,28 @@ After having installed [pathogen.vim], clone the repository under
### Updating the `./vimrc` ### Updating the `./vimrc`
Add the following to the `./vimrc` file. Add the following to the `./vimrc` file.
```vim
set termguicolor + For GUI versions of Vim:
colorscheme odyssey
``` ```vim
colorscheme odyssey
```
+ For terminals that support true color, if 24-bits colors are required, the
following lines must be used:
```vim
set termguicolors
colorscheme odyssey
```
+ For terminals that support 256-colors, if 8-bits colors are required, the
following lines must be used:
```vim
set t_Co=256
colorscheme odyssey
```
## License ## License
+2 -2
View File
@@ -14,7 +14,7 @@
" "
" Maintainer: Ludovic Koenig <ludovic.koenig@gmail.com> " Maintainer: Ludovic Koenig <ludovic.koenig@gmail.com>
" License: MIT " License: MIT
" Release: 0.1.0 " Release: 0.2.0
" Initialisation {{{ " Initialisation {{{
if !has('gui_running') if !has('gui_running')
@@ -139,7 +139,7 @@ let s:colors.error = s:colorize( 0, 45, 70)
let s:colors.warning = s:colorize( 30, 45, 70) let s:colors.warning = s:colorize( 30, 45, 70)
let s:colors.procedure = s:colorize(140, 45, 70) let s:colors.procedure = s:colorize(140, 45, 70)
let s:colors.type = s:colorize(200, 45, 70) let s:colors.type = s:colorize(200, 45, 70)
let s:colors.constant = s:colorize(110, 45, 70) let s:colors.constant = s:colorize( 95, 45, 70)
" }}} " }}}
" Highlight Utilities {{{ " Highlight Utilities {{{