From 41a3a0e55285add2ece5f66b14872fa1b7c18bf8 Mon Sep 17 00:00:00 2001 From: Dariusz Rybicki <dariusz@elixxir.io> Date: Wed, 1 Jun 2022 16:32:50 +0200 Subject: [PATCH] Update README.md --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/README.md b/README.md index 1dcb9ced..49d8fbb4 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) -- GitLab