Skip to content

Commit f900ddb

Browse files
authored
Update README.md
1 parent f35016f commit f900ddb

1 file changed

Lines changed: 53 additions & 0 deletions

File tree

README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,56 @@ The supported package managers are as follows:
1010
- Swift Package Manager
1111
- Carthage
1212
- CocoaPods (only supports the old format that does not use [.xcfilelist](https://blog.cocoapods.org/CocoaPods-1.7.0-beta/))
13+
14+
# Installing
15+
16+
## Swift Package Manager
17+
18+
### Use as CLI
19+
20+
```bash
21+
git clone https://github.com/CuriositySoftware/XcodeTargetGraphGen.git
22+
cd XcodeTargetGraphGen
23+
swift run xcgraphgen [project-file-path]
24+
```
25+
26+
# Usage
27+
28+
Simply run:
29+
30+
```bash
31+
xcgraphgen [project-file-path] [OPTIONS...]
32+
```
33+
34+
```
35+
$ xcgraphgen -h
36+
OVERVIEW: Output Xcode Target Dependency Graph.
37+
38+
USAGE: xcgraphgen [<options>] <project-file-path>
39+
40+
ARGUMENTS:
41+
<project-file-path> .xcodeproj file path.
42+
43+
OPTIONS:
44+
--output-file-path <output-file-path>
45+
Output file path. (default: ./dependencies.md)
46+
--mermaid-theme <mermaid-theme>
47+
Select Mermaid theme type (eg: neutral, forest, dark, base). (default: dark)
48+
--mermaid-syntax-type <mermaid-syntax-type>
49+
Select Mermaid syntax type. (default: flowchart)
50+
--mermaid-chart-direction <mermaid-chart-direction>
51+
Select Mermaid graph/flowchart direction. (default: TD)
52+
--enable-swift-package-output/--disable-swift-package-output
53+
Targeting Swift Package Product for output. (default: --disable-swift-package-output)
54+
--enable-apple-sdk-output/--disable-apple-sdk-output
55+
Targeting Apple SDKs for output. (default: --disable-apple-sdk-output)
56+
--enable-carthage-output/--disable-carthage-output
57+
Targeting Carthage for output. (default: --enable-carthage-output)
58+
--enable-cocoa-pods-output/--disable-cocoa-pods-output
59+
Targeting CocoaPods SDKs for output (only old format without .xcfilelist). (default: --enable-cocoa-pods-output)
60+
--enable-vendor-output/--disable-vendor-output
61+
Targeting vendor project for output. (default: --disable-vendor-output)
62+
--dry-run Output to console without file output
63+
--version Show the version.
64+
-h, --help Show help information.
65+
```

0 commit comments

Comments
 (0)