Update readme and changelog. Prepare for release.

Author: nielssp

CHANGES.md

@@ -1,11 +1,20 @@
 # csol changelog
 
-## Unreleased
+## csol 1.5.0
 
 New features:
 
-- [#4](https://github.com/nielssp/csol/issues/4): Smart cursor movement (`smart_cursor 1` in `csolrc`)
+- [#4](https://github.com/nielssp/csol/issues/4): Smart cursor movement and improvements to shift movement
 - [#5](https://github.com/nielssp/csol/issues/5): Manpage added
+- Alternative cursor style with `alt_cursor`
+
+### Smart cursor
+
+This release changes the default cursor movement. Previously when using the arrow keys or hjkl, the cursor would move a single cell in a grid where each cell is 1 character tall and a card's width plus spacing wide. Since most cells didn't contain moveable cards (or cards at all), a lot of extra key presses were necessary to move between cards. With the new smart cursor movement, the cursor will only move to cells that have cards facing up or cards that can be turned. This means that when pressing for instance the left arrow key, the cursor will move left but may also change position vertically.
+
+Smart cursor movement can be toggled at runtime by pressing <kbd>Ctrl</kbd>+<kbd>S</kbd>, and turned off entirely by adding `smart_cursor 0` to `csolrc`.
+
+I've made this the default because I think it's a better way to play. If you disagree or have ideas for improvements please don't hesitate to [create an issue on GitHub](https://github.com/nielssp/csol/issues).
 
 ## csol 1.4.1
 

README.md

@@ -162,6 +162,8 @@ stats 1
 scores_file scores.csv
 stats_file stats.csv
 smart_cursor 0
+keep_vertical_position 0
+alt_cursor 0
 ```
 
 The `theme_dir` and `game_dir` commands can be used to lazily load theme and game configuration files from a directory.
@@ -172,7 +174,15 @@ The `stats` command enables or disables the use of CSV file to keep track of tot
 
 On Linux the default location for `scores.csv` and `stats.csv` is either `$XDG_DATA_HOME/csol/` or `$HOME/.local/share/csol/`. On DOS and Windows the default location is the same directory as `csol.exe`.
 
-The `smart_cursor` command toggles an alternative cursor movement scheme that always places the cursor on a card.
+The `smart_cursor` command toggles an alternative cursor movement scheme that always places the cursor on a card. `keep_vertical_position` is used in conjunction with the smart cursor, if it's set to 1, then the cursor won't move vertically when moving left and right.
+
+`alt_cursor` switches between two styles of cursor:
+
+`alt_cursor 0`: 
+![alt_cursor 0](images/alt-cursor-0.png)
+
+`alt_cursor 1`:
+![alt_cursor 1](images/alt-cursor-1.png)
 
 ### Themes
 

csolrc

@@ -4,3 +4,7 @@ default_theme default
 default_game klondike
 scores 1
 stats 1
+show_score 0
+smart_cursor 1
+keep_vertical_position 0
+alt_cursor 1

images/alt-cursor-0.png

@@ -1 +1 @@
-#define CSOL_VERSION "1.4.1"
+#define CSOL_VERSION "1.5.0"