Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
kindlychung committed Dec 17, 2016
1 parent 0fe7ebc commit dff2124
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# genicon: A command line tool for generating icons for macOS/iOS apps.
# genicon: A command line tool for generating icons for macOS/iPhone apps.

This tool wraps imagemagick to provide a convenient utility for generating macOS/iOS app icons that conform to Apple's standard. You should feed it a large square image (>= 1024x1024), or (preferrably) an svg file, and get all appropriate sizes plus a proper json index in a `AppIcon.appiconset` folder, which can be directly copied into the `Assets.xcassets` folder in your Xcode project.
This tool wraps imagemagick to provide a convenient utility for generating macOS/iPhone app icons that conform to Apple's standard. You should feed it a large square image (>= 1024x1024), or (preferrably) an svg file, and get all appropriate sizes plus a proper json index in a `AppIcon.appiconset` folder, which can be directly copied into the `Assets.xcassets` folder in your Xcode project.

# Usage

Expand All @@ -17,7 +17,7 @@ Type `genicon` or `genicon -h` in terminal:

--help, -h Print this message.
--mac Generate icons for macOS.
--ios Generate icons for iOS. When neither --mac nor --ios is given, mac icons are generated by default.
--iphone Generate icons for iPhone. When neither --mac nor --iphone is given, mac icons are generated by default.

# Requirements

Expand Down

0 comments on commit dff2124

Please sign in to comment.