Skip to content

Commit 4869c6e

Browse files
authored
Merge pull request #6 from CuriositySoftware/yimajo-patch-1
Add examples in README.md
2 parents 27da7ac + 67b842a commit 4869c6e

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,46 @@ OPTIONS:
6464
-h, --help Show help information.
6565
```
6666

67+
# Examples
68+
69+
```bash
70+
swift run -c release xcgraphgen ./SampleiOSApp/SampleiOSApp.xcodeproj/
71+
```
72+
73+
```mermaid
74+
%%{init: {'theme':'dark'}}%%
75+
flowchart TD
76+
style SampleiOSApp stroke-width:4px
77+
subgraph Swift Package
78+
Algorithms["Algorithms"]
79+
end
80+
subgraph Swift Package Local
81+
Utility["Utility"]
82+
end
83+
subgraph Carthage
84+
APIKit.xcframework["APIKit.xcframework"]
85+
end
86+
subgraph Native Target
87+
APIClient["APIClient"]
88+
AppFeature["AppFeature"]
89+
FeatureA["FeatureA"]
90+
FeatureB["FeatureB"]
91+
SampleiOSApp["SampleiOSApp"]
92+
SampleiOSAppTests["SampleiOSAppTests"]
93+
SampleiOSAppUITests["SampleiOSAppUITests"]
94+
end
95+
FeatureB --> APIClient
96+
FeatureB --> Algorithms
97+
AppFeature --> FeatureA
98+
AppFeature --> FeatureB
99+
SampleiOSAppTests --> SampleiOSApp
100+
SampleiOSAppUITests --> SampleiOSApp
101+
FeatureA --> APIClient
102+
SampleiOSApp --> AppFeature
103+
APIClient --> Utility
104+
APIClient --> APIKit.xcframework
105+
```
106+
67107
# Other libraries
68108

69109
The Swift and iOS communities have other tools for Xcode that have different priorities and tradeoffs than XcodeTargetGraphGen.

0 commit comments

Comments
 (0)