diff --git a/.gitignore b/.gitignore index 2e320e4..a5ce449 100755 --- a/.gitignore +++ b/.gitignore @@ -39,6 +39,5 @@ Package.resolved # Xcode automatically generates this directory with a .xcworkspacedata file and xcuserdata # hence it is not needed unless you have added a package configuration file to your project -# .swiftpm - +.swiftpm .build/ \ No newline at end of file diff --git a/.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata b/.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata deleted file mode 100644 index 919434a..0000000 --- a/.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata +++ /dev/null @@ -1,7 +0,0 @@ - - - - - diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/Chroma.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/Chroma.xcscheme deleted file mode 100644 index de2e1d8..0000000 --- a/.swiftpm/xcode/xcshareddata/xcschemes/Chroma.xcscheme +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/README.md b/README.md index d863d55..1aaa21a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,44 @@ # Chroma A command line tool to generate swift colors definitions from .xcassets files. + +### Usage + +``` +$ Chroma --help + +USAGE: generator [--name ] [--output ] [--platform ] + +OPTIONS: + -n, --name Defines the name of the generated file. (default: + Chroma) + -o, --output Specifies generated file type. + Supported values: "extension","struct". (default: + extension) + -p, --platform + Specifies the platform compatibility of the exported + file. (default: iOS) + -h, --help Show help information. +``` + +### Installation + +Clone Chroma on your machine: + +``` +$ git clone https://github.com/jjotaum/Chroma.git +``` +Navigate to it's directory: + +``` +$ cd Chroma +``` + +Execute install script +``` +$ ./install.sh +``` +Chroma should now be installed on /usr/local/bin and can be accessed via terminal. +``` +$ chroma +``` diff --git a/install.sh b/install.sh new file mode 100755 index 0000000..c3f3f2e --- /dev/null +++ b/install.sh @@ -0,0 +1,5 @@ +#!/bin/sh +swift package clean +swift test +swift build -c release +cp .build/release/Chroma /usr/local/bin/chroma