fix: typo in Windows Cursors

`Unavailiable` -> `Unavailable`
`Dng1` -> `Dgn1`
`Dng2` -> `Dgn2`

Related to #30

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+### Changes
+
+-   Updated build from source commands using new build configs path
+
 ## [v2.0.1] - 02 July 2024
 
 ### :warning: Changes for Developers/Package Distributors
@@ -92,7 +96,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 -   Logo and badges
 -   Initial release 🎊
 
-[unreleased]: https://github.com/ful1e5/BreezeX_Cursor/compare/v2.0.0...main
+[unreleased]: https://github.com/ful1e5/BreezeX_Cursor/compare/v2.0.1...main
+[v2.0.1]: https://github.com/ful1e5/BreezeX_Cursor/compare/v2.0.0...v2.0.1
 [v2.0.0]: https://github.com/ful1e5/BreezeX_Cursor/compare/v1.0.3...v2.0.0
 [v1.0.3]: https://github.com/ful1e5/BreezeX_Cursor/compare/v1.0.2...v1.0.3
 [v1.0.2]: https://github.com/ful1e5/BreezeX_Cursor/compare/v1.0.1...v1.0.2

README.md

@@ -2,6 +2,10 @@
 
 Extended KDE cursor, Highly inspired on **KDE Breeze** for `Windows` and `Linux` with _HiDPi Support_ .
 
+#### Extended!?
+
+BreezeX Cursor is an independent project that supports more XCursor sizes and also offers compatibility with Windows. BreezeX provides more cursor options than the standard Breeze Cursor and allows for customization of colors and cursor sizes using powerful open-source tools.
+
 [![build](https://github.com/ful1e5/BreezeX_Cursor/actions/workflows/build.yml/badge.svg)](https://github.com/ful1e5/BreezeX_Cursor/actions/workflows/build.yml)
 
 ## Notes
@@ -163,7 +167,7 @@ The process of creating custom cursor themes involves two main steps:
 3. `-wc` (optional): Watch Background color, which replaces the `#FF0000` color in the SVG.
 
 ```bash
-npx cbmp [...] -bc '<hex>' -oc '<hex>' -wc '<hex>'
+npx cbmp [...] -bc "<hex>" -oc "<hex>" -wc "<hex>"
 ```
 
 Alternatively, you can provide a JSON configuration file to render SVG files, which contains a sequence of `cbmp` commands:
@@ -179,13 +183,13 @@ npx cbmp render.json
 To build Windows cursor with size `16`:
 
 ```bash
-ctgen build.toml -s 16 -p windows -d 'bitmaps/BreezeX-Dark' -n 'BreezeX-Dark' -c 'Extended Breeze XCursors with size 16'
+ctgen configs/win_lg.build.toml -s 16 -p windows -d "bitmaps/BreezeX-Dark" -n "BreezeX-Dark" -c "Extended Breeze XCursors with size 16"
 ```
 
 You can also customize output directory with `-o` option:
 
 ```bash
-ctgen build.toml -s 16 -p windows -d 'bitmaps/BreezeX-Dark' -o 'out' -n 'BreezeX-Dark' -c 'Extended Breeze Windows Cursors with size 16'
+ctgen configs/win_lg.build.toml -s 16 -p windows -d "bitmaps/BreezeX-Dark" -o "out" -n "BreezeX-Dark" -c "Extended Breeze Windows Cursors with size 16"
 ```
 
 ##### Customize XCursor size
@@ -193,13 +197,13 @@ ctgen build.toml -s 16 -p windows -d 'bitmaps/BreezeX-Dark' -o 'out' -n 'BreezeX
 To build XCursor with size `16`:
 
 ```bash
-ctgen build.toml -s 16 -p x11 -d 'bitmaps/BreezeX-Dark' -n 'BreezeX-Dark' -c 'Extended Breeze XCursors with size 16'
+ctgen configs/x.build.toml -s 16 -p x11 -d "bitmaps/BreezeX-Dark" -n "BreezeX-Dark" -c "Extended Breeze XCursors with size 16"
 ```
 
 You can also assign multiple sizes to `ctgen` for XCursors build:
 
 ```bash
-ctgen build.toml -s 16 18 24 32 -p x11 -d 'bitmaps/BreezeX-Dark' -n 'BreezeX-Dark' -c 'Extended Breeze XCursors with multi-sizes'
+ctgen configs/x.build.toml -s 16 18 24 32 -p x11 -d "bitmaps/BreezeX-Dark" -n "BreezeX-Dark" -c "Extended Breeze XCursors with multi-sizes"
 ```
 
 #### Examples
@@ -207,13 +211,17 @@ ctgen build.toml -s 16 18 24 32 -p x11 -d 'bitmaps/BreezeX-Dark' -n 'BreezeX-Dar
 Lets generate BreezeX Cursor with green and black colors:
 
 ```bash
-npx cbmp -d 'svg' -o 'bitmaps/BreezeX-Hacker' -bc '#00FE00' -oc '#000000'
+npx cbmp -d "svg" -o "bitmaps/BreezeX-Hacker" -bc "#00FE00" -oc "#000000"
 ```
 
 After rendering custom color you have to build cursor through `ctgen`:
 
 ```bash
-ctgen build.toml -d 'bitmaps/BreezeX-Hacker' -n 'BreezeX-Hacker' -c 'Green and Black BreezeX cursors.'
+ctgen configs/x.build.toml -d "bitmaps/BreezeX-Hacker" -n "BreezeX-Hacker" -c "Green and Black BreezeX cursors."
+
+ctgen configs/win_rg.build.toml -d "bitmaps/BreezeX-Hacker" -n "BreezeX-Hacker" -c "Green and Black BreezeX cursors."
+ctgen configs/win_lg.build.toml -d "bitmaps/BreezeX-Hacker" -n "BreezeX-Hacker" -c "Green and Black BreezeX cursors."
+ctgen configs/win_xl.build.toml -d "bitmaps/BreezeX-Hacker" -n "BreezeX-Hacker" -c "Green and Black BreezeX cursors."
 ```
 
 Afterwards, Generated theme can be found in the `themes` directory.
@@ -221,29 +229,50 @@ Afterwards, Generated theme can be found in the `themes` directory.
 ###### BreezeX Gruvbox
 
 ```bash
-npx cbmp -d 'svg/original' -o 'bitmaps/BreezeX-Gruvbox' -bc '#282828' -oc '#EBDBB2'
+npx cbmp -d "svg/original" -o "bitmaps/BreezeX-Gruvbox" -bc "#282828" -oc "#EBDBB2"
-ctgen build.toml -d 'bitmaps/BreezeX-Gruvbox' -n 'BreezeX-Gruvbox' -c 'Groovy BreezeX cursors.'
+
+ctgen configs/x.build.toml -d "bitmaps/BreezeX-Gruvbox" -n "BreezeX-Gruvbox" -c "Groovy BreezeX cursors."
+
+ctgen configs/win_rg.build.toml -d "bitmaps/BreezeX-Gruvbox" -n "BreezeX-Gruvbox" -c "Groovy BreezeX cursors."
+ctgen configs/win_lg.build.toml -d "bitmaps/BreezeX-Gruvbox" -n "BreezeX-Gruvbox" -c "Groovy BreezeX cursors."
+ctgen configs/win_xl.build.toml -d "bitmaps/BreezeX-Gruvbox" -n "BreezeX-Gruvbox" -c "Groovy BreezeX cursors."
 ```
 
 ###### BreezeX Solarized Dark
 
 ```bash
-npx cbmp -d 'svg/original' -o 'bitmaps/BreezeX-Solarized-Dark' -bc '#002b36' -oc '#839496'
+npx cbmp -d "svg/original" -o "bitmaps/BreezeX-Solarized-Dark" -bc "#002b36" -oc "#839496"
-ctgen build.toml -d 'bitmaps/BreezeX-Solarized-Dark' -n 'BreezeX-Solarized-Dark' -c 'Solarized Dark BreezeX cursors.'
+
+ctgen configs/x.build.toml -d "bitmaps/BreezeX-Solarized-Dark" -n "BreezeX-Solarized-Dark" -c "Solarized Dark BreezeX cursors."
+
+ctgen configs/win_rg.build.toml -d "bitmaps/BreezeX-Solarized-Dark" -n "BreezeX-Solarized-Dark" -c "Solarized Dark BreezeX cursors."
+ctgen configs/win_lg.build.toml -d "bitmaps/BreezeX-Solarized-Dark" -n "BreezeX-Solarized-Dark" -c "Solarized Dark BreezeX cursors."
+ctgen configs/win_xl.build.toml -d "bitmaps/BreezeX-Solarized-Dark" -n "BreezeX-Solarized-Dark" -c "Solarized Dark BreezeX cursors."
 ```
 
 ###### BreezeX Solarized Light
 
 ```bash
-npx cbmp -d 'svg/original' -o 'bitmaps/BreezeX-Solarized-Light' -bc '#839496' -oc '#002b36'
+npx cbmp -d "svg/original" -o "bitmaps/BreezeX-Solarized-Light" -bc "#839496" -oc "#002b36"
-ctgen build.toml -d 'bitmaps/BreezeX-Solarized-Light' -n 'BreezeX-Solarized-Light' -c 'Solarized Light BreezeX cursors.'
+
+ctgen configs/x.build.toml -d "bitmaps/BreezeX-Solarized-Light" -n "BreezeX-Solarized-Light" -c "Solarized Light BreezeX cursors."
+
+ctgen configs/win_rg.build.toml -d "bitmaps/BreezeX-Solarized-Light" -n "BreezeX-Solarized-Light" -c "Solarized Light BreezeX cursors."
+ctgen configs/win_lg.build.toml -d "bitmaps/BreezeX-Solarized-Light" -n "BreezeX-Solarized-Light" -c "Solarized Light BreezeX cursors."
+ctgen configs/win_xl.build.toml -d "bitmaps/BreezeX-Solarized-Light" -n "BreezeX-Solarized-Light" -c "Solarized Light BreezeX cursors."
+
 ```
 
 ###### BreezeX Dracula
 
 ```bash
-npx cbmp -d 'svg/original' -o 'bitmaas/BreezeX-Dracula' -bc '#282a36' -oc '#f8f8f2'
+npx cbmp -d "svg/original" -o "bitmaas/BreezeX-Dracula" -bc "#282a36" -oc "#f8f8f2"
-ctgen build.toml -d 'bitmaps/BreezeX-Dracula' -n 'BreezeX-Dracula' -c 'Dracula BreezeX cursors.'
+
+ctgen configs/x.build.toml -d "bitmaps/BreezeX-Dracula" -n "BreezeX-Dracula" -c "Dracula BreezeX cursors."
+
+ctgen configs/win_rg.build.toml -d "bitmaps/BreezeX-Dracula" -n "BreezeX-Dracula" -c "Dracula BreezeX cursors."
+ctgen configs/win_lg.build.toml -d "bitmaps/BreezeX-Dracula" -n "BreezeX-Dracula" -c "Dracula BreezeX cursors."
+ctgen configs/win_xl.build.toml -d "bitmaps/BreezeX-Dracula" -n "BreezeX-Dracula" -c "Dracula BreezeX cursors."
 ```
 
 ## Testing Cursor

configs/win_lg.build.toml

@@ -25,7 +25,7 @@ win_name = 'Move'
 png = 'bd_double_arrow.png'
 x_hotspot = 127
 y_hotspot = 124
-win_name = 'Dng1'
+win_name = 'Dgn1'
 
 [cursors.cross]
 png = 'cross.png'
@@ -33,13 +33,13 @@ win_name = 'Cross'
 
 [cursors.dnd_no_drop]
 png = 'dnd_no_drop.png'
-win_name = 'Unavailiable'
+win_name = 'Unavailable'
 
 [cursors.fd_double_arrow]
 png = 'fd_double_arrow.png'
 x_hotspot = 126
 y_hotspot = 125
-win_name = 'Dng2'
+win_name = 'Dgn2'
 
 [cursors.hand1]
 png = 'hand1.png'

configs/win_rg.build.toml

@@ -25,7 +25,7 @@ win_name = 'Move'
 png = 'bd_double_arrow.png'
 x_hotspot = 127
 y_hotspot = 124
-win_name = 'Dng1'
+win_name = 'Dgn1'
 
 [cursors.cross]
 png = 'cross.png'
@@ -33,13 +33,13 @@ win_name = 'Cross'
 
 [cursors.dnd_no_drop]
 png = 'dnd_no_drop.png'
-win_name = 'Unavailiable'
+win_name = 'Unavailable'
 
 [cursors.fd_double_arrow]
 png = 'fd_double_arrow.png'
 x_hotspot = 126
 y_hotspot = 125
-win_name = 'Dng2'
+win_name = 'Dgn2'
 
 [cursors.hand1]
 png = 'hand1.png'

configs/win_xl.build.toml

@@ -25,7 +25,7 @@ win_name = 'Move'
 png = 'bd_double_arrow.png'
 x_hotspot = 127
 y_hotspot = 124
-win_name = 'Dng1'
+win_name = 'Dgn1'
 
 [cursors.cross]
 png = 'cross.png'
@@ -33,13 +33,13 @@ win_name = 'Cross'
 
 [cursors.dnd_no_drop]
 png = 'dnd_no_drop.png'
-win_name = 'Unavailiable'
+win_name = 'Unavailable'
 
 [cursors.fd_double_arrow]
 png = 'fd_double_arrow.png'
 x_hotspot = 126
 y_hotspot = 125
-win_name = 'Dng2'
+win_name = 'Dgn2'
 
 [cursors.hand1]
 png = 'hand1.png'