diff --git a/README.md b/README.md index 1dcb9cedd6da2b43ccf2a9bb14263d3e662b9577..49d8fbb44a5398de29a79d5b13be47e1ba0db1d0 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,38 @@   + +## 🛠Development + +Open `ElixxirDAppsSDK.xcworkspace` in Xcode (≥13.4). + +### Project structure + +``` +ElixxirDAppsSDK [Xcode Workspace] + ├─ elixxir-dapps-sdk-swift [Swift Package] + | └─ ElixxirDAppsSDK [Library] + └─ Example [Xcode Project] + ├─ ExampleApp (iOS) [iOS App Target] + ├─ example-app [Swift Package] + | ├─ AppFeature [Library] + | └─ ... + └─ example-app-icon [Swift Package] + ├─ ExampleAppIcon [Library] + └─ example-app-icon-export [Executable] +``` + +### Build schemes + +- Use `exlixxir-dapps-sdk-swift` scheme to build the package with `ElixxirDAppsSDK` library. +- Use `ExampleApp (iOS)` to build and run the example app. +- Use `example-app` scheme to build and test the example app package with all contained libraries. +- Use `ExampleAppIcon` scheme with macOS target to build and preview the example app icon. +- Use `example-app-icon-export` scheme with macOS target to build and update the example app icon. +- Use other schemes, like `AppFeature`, for building and testing individual libraries in isolation. + +## 📄 License + +Copyright © 2022 xx network SEZC + +[License](LICENSE)