Skip to content
This repository has been archived by the owner on Jul 3, 2024. It is now read-only.

Commit

Permalink
Version 0.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jhauberg committed Jun 17, 2022
1 parent 8a34722 commit f777c2e
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A command-line tool that helps diagnosing your Xcode project for common defects.

| [Latest release (0.5.1)](https://github.com/jhauberg/xcdoctor/releases/tag/0.5.1) | Download the latest stable release. |
| [Latest release (0.6.0)](https://github.com/jhauberg/xcdoctor/releases/tag/0.6.0) | Download the latest stable release. |
| :-------------------------------------------------------------------------------- | :-------------------------------------------------- |
| [Issue tracker](https://github.com/jhauberg/xcdoctor/issues) | Contribute your bugs, comments or feature requests. |

Expand Down Expand Up @@ -54,19 +54,20 @@ $ xcdoctor --help
```

```console
USAGE: xcdoctor <xcodeproj> [--verbose]
USAGE: xcdoctor <xcodeproj> [--keep-comments] [--verbose]

ARGUMENTS:
<xcodeproj> A path to an Xcode project file.
<xcodeproj> A path to an Xcode project file (for example, "MyProject.xcodeproj").

You can put in a path to a directory to automatically
look for a project at that location, or "." to look
for a project in the current working directory.

OPTIONS:
--keep-comments Don't strip comments from source files (block, line and xml comments).
-v, --verbose Show diagnostic messages.
-h, --help Show help information.
--version Show the version.
-h, --help Show help information.
```

At this point, you can direct `xcdoctor` to your Xcode project to initiate an [examination](#examination):
Expand All @@ -83,7 +84,7 @@ Note that `xcdoctor` is _only_ able to examine [`.xcodeproj`](http://www.monobjc

The purpose of an examination is to discover and identify defects in an Xcode project.

This process includes resolving and validating file/group references, determining unused resources and more. For a complete list of checks, see [Diagnosis.swift](https://github.com/jhauberg/xcdoctor/blob/master/Sources/XCDoctor/Diagnosis.swift#L14-L49).
This process includes resolving and validating file/group references, determining unused resources and more. For a complete list of checks, see [Diagnosis.swift](https://github.com/jhauberg/xcdoctor/blob/master/Sources/XCDoctor/Diagnosis.swift#L14-L67).

**No files are touched during an examination;** the user must manually take action on any reported defects.

Expand Down

0 comments on commit f777c2e

Please sign in to comment.