Skip to content

Commit 86a584f

Browse files
committed
docs: fixed build commands
1 parent ee9ea9c commit 86a584f

File tree

2 files changed

+26
-9
lines changed

2 files changed

+26
-9
lines changed

CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [unreleased]
99

10+
### Changes
11+
- Fixed build commands in Readme
1012
## [v2.0.1] - 05 May 2024
1113

1214
### :warning: Breaking Changes

README.md

+24-9
Original file line numberDiff line numberDiff line change
@@ -192,27 +192,27 @@ npx cbmp render.json
192192
To build Windows cursor with size `16`:
193193

194194
```bash
195-
ctgen build.toml -s 16 -p windows -d "bitmaps/macOS" -n "macOS" -c "macOS Cursors with size 16"
195+
ctgen configs/win_rg.build.toml -s 16 -p windows -d "bitmaps/macOS" -n "macOS" -c "macOS Cursors with size 16"
196196
```
197197

198198
You can also customize output directory with `-o` option:
199199

200200
```bash
201-
ctgen build.toml -s 16 -p windows -d "bitmaps/macOS" -o "out" -n "macOS" -c "macOS Cursors with size 16"
201+
ctgen configs/win_rg.build.toml -s 16 -p windows -d "bitmaps/macOS" -o "out" -n "macOS" -c "macOS Cursors with size 16"
202202
```
203203

204204
##### Customize XCursor size
205205

206206
To build XCursor with size `16`:
207207

208208
```bash
209-
ctgen build.toml -s 16 -p x11 -d "bitmaps/macOS" -n "macOS" -c "macOS XCursors with size 16"
209+
ctgen configs/x.build.toml -s 16 -p x11 -d "bitmaps/macOS" -n "macOS" -c "macOS XCursors with size 16"
210210
```
211211

212212
You can also assign multiple sizes to `ctgen` for XCursors build:
213213

214214
```bash
215-
ctgen build.toml -s 16 24 32 -p x11 -d "bitmaps/macOS" -n "macOS" -c "Custom Sizes macOS XCursors"
215+
ctgen configs/x.build.toml -s 16 24 32 -p x11 -d "bitmaps/macOS" -n "macOS" -c "Custom Sizes macOS XCursors"
216216
```
217217

218218
#### Examples
@@ -226,7 +226,10 @@ npx cbmp -d "svg" -o "bitmaps/macOS-Hacker" -bc "#00FE00" -oc "#000000"
226226
After rendering custom color you have to build cursor through `ctgen`:
227227

228228
```bash
229-
ctgen build.toml -d "bitmaps/macOS-Hacker" -n "macOS-Hacker" -c "Green and Black macOS cursors."
229+
ctgen configs/x.build.toml -d "bitmaps/macOS-Hacker" -n "macOS-Hacker" -c "Green and Black macOS cursors."
230+
ctgen configs/win_rg.build.toml -d "bitmaps/macOS-Hacker" -n "macOS-Hacker" -c "Green and Black macOS Regular Windows Cursors."
231+
ctgen configs/win_lg.build.toml -d "bitmaps/macOS-Hacker" -n "macOS-Hacker" -c "Green and Black macOS Large Windows Cursors."
232+
ctgen configs/win_xl.build.toml -d "bitmaps/macOS-Hacker" -n "macOS-Hacker" -c "Green and Black macOS Extra Large Windows Cursors."
230233
```
231234

232235
Afterwards, Generated theme can be found in the `themes` directory.
@@ -235,28 +238,40 @@ Afterwards, Generated theme can be found in the `themes` directory.
235238

236239
```bash
237240
npx cbmp -d "svg" -o "bitmaps/macOS-Gruvbox" -bc "#282828" -oc "#EBDBB2" -wc "#000000"
238-
ctgen build.toml -d "bitmaps/macOS-Gruvbox" -n "macOS-Gruvbox" -c "Groovy macOS cursors."
241+
ctgen configs/x.build.toml -d "bitmaps/macOS-Gruvbox" -n "macOS-Gruvbox" -c "Groovy macOS XCursors."
242+
ctgen configs/win_rg.build.toml -d "bitmaps/macOS-Gruvbox" -n "macOS-Gruvbox" -c "Groovy macOS Windows Regular Cursors."
243+
ctgen configs/win_lg.build.toml -d "bitmaps/macOS-Gruvbox" -n "macOS-Gruvbox" -c "Groovy macOS Windows Large Cursors."
244+
ctgen configs/win_xl.build.toml -d "bitmaps/macOS-Gruvbox" -n "macOS-Gruvbox" -c "Groovy macOS Windows Extra Large Cursors."
239245
```
240246

241247
###### macOS Solarized Dark
242248

243249
```bash
244250
npx cbmp -d "svg" -o "bitmaps/macOS-Solarized-Dark" -bc "#002b36" -oc "#839496" -wc "#000000"
245-
ctgen build.toml -d "bitmaps/macOS-Solarized-Dark" -n "macOS-Solarized-Dark" -c "Solarized Dark macOS cursors."
251+
ctgen configs/x.build.toml -d "bitmaps/macOS-Solarized-Dark" -n "macOS-Solarized-Dark" -c "Solarized Dark macOS XCursors."
252+
ctgen configs/win_rg.build.toml -d "bitmaps/macOS-Solarized-Dark" -n "macOS-Solarized-Dark" -c "Solarized Dark macOS Regular Windows Cursors."
253+
ctgen configs/win_lg.build.toml -d "bitmaps/macOS-Solarized-Dark" -n "macOS-Solarized-Dark" -c "Solarized Dark macOS Regular Large Cursors."
254+
ctgen configs/win_xl.build.toml -d "bitmaps/macOS-Solarized-Dark" -n "macOS-Solarized-Dark" -c "Solarized Dark macOS Regular Extra Large Cursors."
246255
```
247256

248257
###### macOS Solarized Light
249258

250259
```bash
251260
npx cbmp -d "svg" -o "bitmaps/macOS-Solarized-Light" -bc "#839496" -oc "#002b36"
252-
ctgen build.toml -d "bitmaps/macOS-Solarized-Light" -n "macOS-Solarized-Light" -c "Solarized Light macOS cursors."
261+
ctgen configs/x.build.toml -d "bitmaps/macOS-Solarized-Light" -n "macOS-Solarized-Light" -c "Solarized Light macOS XCursors."
262+
ctgen configs/win_rg.build.toml -d "bitmaps/macOS-Solarized-Light" -n "macOS-Solarized-Light" -c "Solarized Light macOS Regular Windows Cursors."
263+
ctgen configs/win_lg.build.toml -d "bitmaps/macOS-Solarized-Light" -n "macOS-Solarized-Light" -c "Solarized Light macOS Large Windows Cursors."
264+
ctgen configs/win_xl.build.toml -d "bitmaps/macOS-Solarized-Light" -n "macOS-Solarized-Light" -c "Solarized Light macOS Extra Large Windows Cursors."
253265
```
254266

255267
###### macOS Dracula
256268

257269
```bash
258270
npx cbmp -d "svg" -o "bitmaas/macOS-Dracula" -bc "#282a36" -oc "#f8f8f2"
259-
ctgen build.toml -d "bitmaps/macOS-Dracula" -n "macOS-Dracula" -c "Dracula macOS cursors."
271+
ctgen configs/x.build.toml -d "bitmaps/macOS-Dracula" -n "macOS-Dracula" -c "Dracula macOS XCursors."
272+
ctgen configs/win_rg.build.toml -d "bitmaps/macOS-Dracula" -n "macOS-Dracula" -c "Dracula macOS Regular Windows Cursors."
273+
ctgen configs/win_lg.build.toml -d "bitmaps/macOS-Dracula" -n "macOS-Dracula" -c "Dracula macOS Large Windows Cursors."
274+
ctgen configs/win_xl.build.toml -d "bitmaps/macOS-Dracula" -n "macOS-Dracula" -c "Dracula macOS Extra Large Windows Cursors."
260275
```
261276

262277
## Testing Cursor

0 commit comments

Comments
 (0)