Skip to content

Commit

Permalink
add simpler running instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
mattmassicotte authored Nov 16, 2023
1 parent c4314ab commit 5f458dc
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,11 @@ targets: [

## Tool Usage

Just point the `xclint` binary at your `.xcodeproj`. Check out its `-h` flag for more usage.
Just run the `xclint` binary in your project directory. Check out its `-h` flag for more usage.

```
# xclint /path/to/MyProject.xcodeproj
# cd my/project
# xclint
```

This will run a default set of rules. But, you can customize its behavior with a `.xclint.yml` file. The basic structure borrows a lot from [SwiftLint](https://github.com/realm/SwiftLint).
Expand Down

0 comments on commit 5f458dc

Please sign in to comment.