From 5f458dc98ef8375bbd08f8d68e6ff249d55b79d3 Mon Sep 17 00:00:00 2001 From: Matt Massicotte <85322+mattmassicotte@users.noreply.github.com> Date: Thu, 16 Nov 2023 08:42:25 -0500 Subject: [PATCH] add simpler running instructions --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5c98e33..d352bac 100644 --- a/README.md +++ b/README.md @@ -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).