Skip to content

Commit

Permalink
docs: fixed build commands
Browse files Browse the repository at this point in the history
  • Loading branch information
ful1e5 committed Aug 8, 2024
1 parent ee9ea9c commit 86a584f
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 9 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [unreleased]

### Changes
- Fixed build commands in Readme
## [v2.0.1] - 05 May 2024

### :warning: Breaking Changes
Expand Down
33 changes: 24 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,27 +192,27 @@ npx cbmp render.json
To build Windows cursor with size `16`:

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

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

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

##### Customize XCursor size

To build XCursor with size `16`:

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

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

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

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

```bash
ctgen build.toml -d "bitmaps/macOS-Hacker" -n "macOS-Hacker" -c "Green and Black macOS cursors."
ctgen configs/x.build.toml -d "bitmaps/macOS-Hacker" -n "macOS-Hacker" -c "Green and Black macOS cursors."
ctgen configs/win_rg.build.toml -d "bitmaps/macOS-Hacker" -n "macOS-Hacker" -c "Green and Black macOS Regular Windows Cursors."
ctgen configs/win_lg.build.toml -d "bitmaps/macOS-Hacker" -n "macOS-Hacker" -c "Green and Black macOS Large Windows Cursors."
ctgen configs/win_xl.build.toml -d "bitmaps/macOS-Hacker" -n "macOS-Hacker" -c "Green and Black macOS Extra Large Windows Cursors."
```

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

```bash
npx cbmp -d "svg" -o "bitmaps/macOS-Gruvbox" -bc "#282828" -oc "#EBDBB2" -wc "#000000"
ctgen build.toml -d "bitmaps/macOS-Gruvbox" -n "macOS-Gruvbox" -c "Groovy macOS cursors."
ctgen configs/x.build.toml -d "bitmaps/macOS-Gruvbox" -n "macOS-Gruvbox" -c "Groovy macOS XCursors."
ctgen configs/win_rg.build.toml -d "bitmaps/macOS-Gruvbox" -n "macOS-Gruvbox" -c "Groovy macOS Windows Regular Cursors."
ctgen configs/win_lg.build.toml -d "bitmaps/macOS-Gruvbox" -n "macOS-Gruvbox" -c "Groovy macOS Windows Large Cursors."
ctgen configs/win_xl.build.toml -d "bitmaps/macOS-Gruvbox" -n "macOS-Gruvbox" -c "Groovy macOS Windows Extra Large Cursors."
```

###### macOS Solarized Dark

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

###### macOS Solarized Light

```bash
npx cbmp -d "svg" -o "bitmaps/macOS-Solarized-Light" -bc "#839496" -oc "#002b36"
ctgen build.toml -d "bitmaps/macOS-Solarized-Light" -n "macOS-Solarized-Light" -c "Solarized Light macOS cursors."
ctgen configs/x.build.toml -d "bitmaps/macOS-Solarized-Light" -n "macOS-Solarized-Light" -c "Solarized Light macOS XCursors."
ctgen configs/win_rg.build.toml -d "bitmaps/macOS-Solarized-Light" -n "macOS-Solarized-Light" -c "Solarized Light macOS Regular Windows Cursors."
ctgen configs/win_lg.build.toml -d "bitmaps/macOS-Solarized-Light" -n "macOS-Solarized-Light" -c "Solarized Light macOS Large Windows Cursors."
ctgen configs/win_xl.build.toml -d "bitmaps/macOS-Solarized-Light" -n "macOS-Solarized-Light" -c "Solarized Light macOS Extra Large Windows Cursors."
```

###### macOS Dracula

```bash
npx cbmp -d "svg" -o "bitmaas/macOS-Dracula" -bc "#282a36" -oc "#f8f8f2"
ctgen build.toml -d "bitmaps/macOS-Dracula" -n "macOS-Dracula" -c "Dracula macOS cursors."
ctgen configs/x.build.toml -d "bitmaps/macOS-Dracula" -n "macOS-Dracula" -c "Dracula macOS XCursors."
ctgen configs/win_rg.build.toml -d "bitmaps/macOS-Dracula" -n "macOS-Dracula" -c "Dracula macOS Regular Windows Cursors."
ctgen configs/win_lg.build.toml -d "bitmaps/macOS-Dracula" -n "macOS-Dracula" -c "Dracula macOS Large Windows Cursors."
ctgen configs/win_xl.build.toml -d "bitmaps/macOS-Dracula" -n "macOS-Dracula" -c "Dracula macOS Extra Large Windows Cursors."
```

## Testing Cursor
Expand Down

0 comments on commit 86a584f

Please sign in to comment.