Skip to content

Commit

Permalink
[#495] Modify readme for Swift command
Browse files Browse the repository at this point in the history
  • Loading branch information
blyscuit committed Aug 30, 2023
1 parent 32ba7c4 commit 39da56f
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 24 deletions.
2 changes: 1 addition & 1 deletion .github/wiki/Deliverable-Configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The file [DeliverableConstants.rb](https://github.com/nimblehq/ios-templates/blo

## Use the template

1. Running the `make.sh` script will ask if the developer wants to configure the `DeliverableConstants` file.
1. Running the `iOSTemplateMaker` script will ask if the developer wants to configure the `DeliverableConstants` file.
2. When confirming with the prompt, the template will launch Xcode to modify the `DeliverableConstants` file.

## Configure later
Expand Down
14 changes: 13 additions & 1 deletion .github/wiki/Getting-Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,17 @@
2. Clone your repository
3. Setup the project by running the following command in your terminal:
```bash
sh make.sh --bundle-id [BUNDLE_ID_PRODUCTION] --bundle-id-staging [BUNDLE_ID_STAGING] --project-name [PROJECT_NAME]
swift run --package-path Scripts/Swift/iOSTemplateMaker iOSTemplateMaker make
```

## Options

Options are optional and will be prompted if not provided. Example is provided in (brackets).

- `--bundle-id-production`: The application's bundle id for production variant. (co.nimblehq.project)
- `--bundle-id-staging`: The application's bundle id for staging variant. (co.nimblehq.project.staging)
- `--project-name`: The name of the project. (Project)
- `--minimum-version`: The minimum version of the iOS application. (14.0)
- `--interface`: The user interface. (UIKit or SwiftUI)

```
2 changes: 1 addition & 1 deletion .github/wiki/Selecting-User-Interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ Current the template supports setup with two user interfaces:
To select a user interface when creating a project pass the argument `--interface [SwiftUI or UIKit]` with the `make` script.

```bash
sh make.sh --bundle-id [BUNDLE_ID_PRODUCTION] --bundle-id-staging [BUNDLE_ID_STAGING] --project-name [PROJECT_NAME] --interface SwiftUI
swift run --package-path Scripts/Swift/iOSTemplateMaker iOSTemplateMaker make --interface SwiftUI
```
4 changes: 1 addition & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,4 @@ dependencies/

# Environment
.env
Scripts/Swift/iOSTemplateMaker/.swiftpm/xcode/package.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist
Scripts/Swift/iOSTemplateMaker/.build
Scripts/Swift/iOSTemplateMaker/.swiftpm
Scripts/Swift/iOSTemplateMaker/.*
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Our optimized iOS template used in our projects using Xcode Templates
2. Clone your repository
3. Setup the project by running the following command in your terminal:
```bash
sh make.sh --bundle-id [BUNDLE_ID_PRODUCTION] --bundle-id-staging [BUNDLE_ID_STAGING] --project-name [PROJECT_NAME]
swift run --package-path Scripts/Swift/iOSTemplateMaker iOSTemplateMaker make
```

## Full Documentation
Expand All @@ -53,4 +53,4 @@ We love open source and do our part in sharing our work with the community!
See [our other projects][community] or [hire our team][hire] to help build your product.

[community]: https://github.com/nimblehq
[hire]: https://nimblehq.co/
[hire]: https://nimblehq.co/
3 changes: 0 additions & 3 deletions Scripts/Swift/iOSTemplateMaker/README.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,6 @@ class SetUpIOSProject {
fileManager.removeItems(in: "Workspace.swift")

print("Remove script files and git/index")
fileManager.removeItems(in: "make.sh")
fileManager.removeItems(in: ".github/workflows/test_install_script.yml")
fileManager.removeItems(in: ".git/index")
try safeShell("git reset")
Expand All @@ -162,7 +161,6 @@ class SetUpIOSProject {
SetUpCICDService().perform()
SetUpDeliveryConstants().perform()
fileManager.removeItems(in: "fastlane/Tests")
fileManager.removeItems(in: "set_up_test_testflight.sh")
fileManager.removeItems(in: "Scripts")
}
print("✅ Completed")
Expand Down
Empty file.

This file was deleted.

0 comments on commit 39da56f

Please sign in to comment.