Skip to content

Commit e58effc

Browse files
committed
Add LICENSE and README
1 parent 3f17e1d commit e58effc

File tree

2 files changed

+71
-0
lines changed

2 files changed

+71
-0
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 xiyaowong
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# toico
2+
3+
toico is a tool for converting image files to ICO format
4+
5+
# Installation
6+
7+
Download the executable from the releases page, or install via cargo:
8+
9+
```bash
10+
cargo install --git https://github.com/xiyaowong/toico
11+
```
12+
13+
# Usage
14+
15+
```bash
16+
toico -h
17+
```
18+
19+
```
20+
Convert images to ICO format
21+
22+
Usage: toico [OPTIONS] <IMAGE>
23+
24+
Arguments:
25+
<IMAGE> The image file to convert
26+
27+
Options:
28+
-s, --size <SIZE> The size of the icon in pixels: 16, 24, 32, 48, 64, 128, 256 [default: 64]
29+
-o, --output <OUTPUT> The output file name, defaults to the input file name
30+
31+
If the --all option is specified, files will be saved in a directory named <output>_ico
32+
If --all is not specified, the file will be saved as <output>.ico
33+
34+
-a, --all Whether to generate all icon sizes (16, 24, 32, 48, 64, 128, 256)
35+
-f, --force Force overwrite existing files
36+
-h, --help Print help
37+
-V, --version Print version
38+
39+
40+
Examples:
41+
toico image.png --size 64
42+
toico image.png -s 64 --output my_icon
43+
44+
Tips:
45+
Drag and drop an image file onto the executable to convert it to ICO format.
46+
```
47+
48+
# License
49+
50+
MIT

0 commit comments

Comments
 (0)