Merge pull request #547 from nimblehq/feature/534-add-readme-for-proj…

…ect-setup-instructions [#534] Add README for project setup instructions
nimblehq · Jun 3, 2024 · 36cd772 · 36cd772
2 parents 11790f1 + ad0248f
commit 36cd772
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/PROJECT_README.md b/PROJECT_README.md
@@ -0,0 +1,20 @@
+<p align="center">
+  <strong>{PROJECT_NAME}</strong>
+</p>
+
+---
+
+## Getting Started
+
+### Requirements
+
+- Ruby `3.1.2`
+- Xcode `15+`
+
+### Install Dependencies
+
+- `bundle install`
+- `bundle exec arkana` _(generate keys from `.env`)_
+- `bundle exec pod install`
+
+Build with Xcode.
diff --git a/Scripts/Swift/iOSTemplateMaker/Sources/iOSTemplateMaker/SetUpiOSProject.swift b/Scripts/Swift/iOSTemplateMaker/Sources/iOSTemplateMaker/SetUpiOSProject.swift
@@ -80,6 +80,8 @@ class SetUpIOSProject {
         fileManager.rename(file: "\(CONSTANT_PROJECT_NAME)Tests", to: "\(projectNameNoSpace)Tests")
         fileManager.rename(file: "\(CONSTANT_PROJECT_NAME)KIFUITests", to: "\(projectNameNoSpace)KIFUITests")
         fileManager.rename(file: "\(CONSTANT_PROJECT_NAME)", to: "\(projectNameNoSpace)")
+        fileManager.removeItems(in: "README.md")
+        fileManager.rename(file: "PROJECT_README.md", to: "README.md")
     }
 
     private func createPlaceholderFiles() {