prepare v2.2.3

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+## [v2.2.3] - 25 May 2024
+
 ### What's New?
 
 -   Clickgen now allows cursor bitmap re-canvasing by specifying size using the `cursor_size:canvas_size` format. See [changelog-05212024](https://github.com/ful1e5/clickgen/discussions/59#discussioncomment-9511166)
@@ -348,7 +350,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 -   auto-generated **symlinks** based on input configs
 -   `.tar` archive & `directory` as out **package**.
 
-[unreleased]: https://github.com/ful1e5/clickgen/compare/v2.2.2...main
+[unreleased]: https://github.com/ful1e5/clickgen/compare/v2.2.3...main
+[v2.2.3]: https://github.com/ful1e5/clickgen/compare/v2.2.2...v2.2.3
 [v2.2.2]: https://github.com/ful1e5/clickgen/compare/v2.2.1...v2.2.2
 [v2.2.1]: https://github.com/ful1e5/clickgen/compare/v2.2.0...v2.2.1
 [v2.2.0]: https://github.com/ful1e5/clickgen/compare/v2.1.9...v2.2.0

README.md

@@ -57,13 +57,13 @@ pip3 install clickgen
 For example, if you have to build [ponter.png](https://github.com/ful1e5/clickgen/blob/main/samples/pngs/pointer.png)
 file to Linux Format:
 
-```
+```bash
 clickgen samples/pngs/pointer.png -x 10 -y 10 -s 22 24 32 -p x11
 ```
 
 You also **build animated Xcursor** by providing multiple png files to argument and animation delay with `-d`:
 
-```
+```bash
 clickgen samples/pngs/wait-001.png samples/pngs/wait-001.png -d 3 -x 10 -y 10 -s 22 24 32 -p x11
 ```
 
@@ -72,15 +72,21 @@ clickgen samples/pngs/wait-001.png samples/pngs/wait-001.png -d 3 -x 10 -y 10 -s
 To build [ponter.png](https://github.com/ful1e5/clickgen/blob/main/samples/pngs/pointer.png)
 file to Windows Format (`.cur`):
 
-> **Warning: Windows Cursor only support single size.**
+> **Warning: Windows Animated Cursor only support single size.**
 
-```
+```bash
 clickgen samples/pngs/pointer.png -x 10 -y 10 -s 32 -p windows
 ```
 
-For **animated Windows Cursor** (`.ani`):
+You can also specify the size in the `size:canvas_size` format to enable canvasing:
 
+```bash
+clickgen samples/pngs/pointer.png -x 10 -y 10 -s 20:32 -p windows
 ```
+
+For **animated Windows Cursor** (`.ani`):
+
+```bash
 clickgen samples/pngs/wait-001.png samples/pngs/wait-001.png -d 3 -x 10 -y 10 -s 32 -p windows
 ```
 
@@ -98,13 +104,13 @@ ctgen sample/sample.yaml
 
 You also provide multiple theme configuration file once as following:
 
-```
+```bash
 ctgen sample/sample.toml sample/sample.json
 ```
 
 Override theme's `name` of theme with `-n` option:
 
-```
+```bash
 ctgen sample/sample.toml -n "New Theme"
 ```
 

src/clickgen/__init__.py

@@ -1,4 +1,4 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-__version__ = "2.2.2"
+__version__ = "2.2.3"

src/clickgen/scripts/clickgen.py

@@ -63,7 +63,8 @@ def main() -> None:
         nargs="+",
         default=SIZES,
         type=str,
-        help="Set pixel-size for cursor.",
+        help="""Specify the cursor size(s) either as a single integer value or
+        in the 'size:canvas_size' format to resize the cursor to a specific canvas size.""",
     )
     parser.add_argument(
         "-d",

src/clickgen/scripts/ctgen.py

@@ -123,9 +123,8 @@ def main() -> None:  # noqa: C901
         nargs="+",
         default=None,
         type=str,
-        help=""" Change cursor size.
-        Multiple sizes are assigned to XCursor
-        while one size will be assigned to Windows.""",
+        help="""Specify the cursor size(s) either as a single integer value or
+        in the 'size:canvas_size' format to resize the cursor to a specific canvas size.""",
     )
 
     parser.add_argument(