Skip to content

Commit

Permalink
Update readme and version
Browse files Browse the repository at this point in the history
  • Loading branch information
onevcat committed May 12, 2022
1 parent b4f528d commit 7fd538b
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 8 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,5 @@ fastlane/test_output
# End of https://www.gitignore.io/api/swift,osx
/fengniao.sketch

.swiftpm
.swiftpm
.vscode
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,29 @@ FengNiao is a simple command-line util to deleting unused image resource files f

### Install

You need Swift Package Manager (as well as swift compiler) installed in your macOS; generally you are prepared if you have the latest Xcode installed.
#### Mint

[Mint](https://github.com/yonaskolb/Mint) is a tool that installs and runs Swift command line tool packages. Make sure
you have Xcode installed, then:

```sh
> brew install mint
> mint install onevcat/fengniao
```

#### Compile from source

```bash
> git clone https://github.com/onevcat/FengNiao.git
> cd FengNiao
> ./install.sh
> swift build -c release

# Then copy the executable to your PATH, such as `/usr/local/bin`
> sudo cp .build/release/FengNiao /usr/local/bin/fengniao
```

FengNiao should be compiled, tested and installed into the `/usr/local/bin`.

#### Homebrew

You may want to install in from Homebrew. But for now it is not supported.

### Usage

Just navigate to your project folder, then:
Expand Down
2 changes: 1 addition & 1 deletion Sources/FengNiao/main.swift
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import Rainbow
import FengNiaoKit
import PathKit

let appVersion = "0.7.0"
let appVersion = "0.8.1"

#if os(Linux)
let EX_OK: Int32 = 0
Expand Down

0 comments on commit 7fd538b

Please sign in to comment.