From eaa3b8ded5bda68b17de40ba2d514416ff7f5d7e Mon Sep 17 00:00:00 2001 From: Aleksandrs Proskurins Date: Tue, 18 Oct 2022 16:12:24 +0300 Subject: [PATCH] Updated templates readme.md file --- Tools/Templates/README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/Tools/Templates/README.md b/Tools/Templates/README.md index dc1bb15b6..3f83b42c4 100644 --- a/Tools/Templates/README.md +++ b/Tools/Templates/README.md @@ -33,6 +33,39 @@ To use it (before it becomes an Xcode template): - Import created files in the Xcode project +# SwiftUISimpleScreenTemplate +This is the boilerplate to create a simple SwiftUI screen including view model, screen coordinator, unit and UI tests. + +To create a screen from this template (before it becomes an Xcode template): + +- `./createSwiftUISimpleScreen.sh ScreenFolder MyScreenName` +- Import created files in the Xcode project + +This will create `ScreenFolder` within the `RiotSwiftUI/Modules`. Files inside will be named `MyScreenNameXxx`. + + +# SwiftUISingleScreenTempalte +This is the boilerplate to create a simple SwiftUI screen including view model, screen coordinator, service, unit and UI tests. + +To create a screen from this template (before it becomes an Xcode template): + +- `./createSwiftUISingleScreen.sh ScreenFolder MyScreenName` +- Import created files in the Xcode project + +This will create `ScreenFolder` within the `RiotSwiftUI/Modules`. Files inside will be named `MyScreenNameXxx`. + + +# SwiftUITwoScreenTemplate +This is the boilerplate to create two single SwiftUI screens (including view models, screen coordinators, services, unit and UI tests) and a flow coordinator. + +To create screens from this template (before it becomes an Xcode template): + +- `./createSwiftUITwoScreen.sh TwoScreenFolder MyRootCoordinator FirstScreenName SecondScreenName` +- Import created files in the Xcode project + +This will create `TwoScreenFolder` within the `RiotSwiftUI/Modules`. + + # Usage example Following commands: