Update Setup

Scripts/TEMPLATEREADME.md

@@ -0,0 +1,32 @@
+<!--
+
+This source file is part of the Stanford Spezi Template Application open-source project
+
+SPDX-FileCopyrightText: 2023 Stanford University
+
+SPDX-License-Identifier: MIT
+
+-->
+
+# Spezi Template Application
+
+This repository contains the Spezi Template Application.
+The Spezi Template Application is using the [Spezi](https://github.com/StanfordSpezi/Spezi) ecosystem and builds on top of the [SSTA](https://github.com/StanfordSpezi/TA).
+
+> [!NOTE] 
+> Do you want to learn more about the SSTA and how to use, extend, and modify this application? Check out the [SSTA documentation](stanfordspezi.github.io/SpeziTA/)
+
+
+## Spezi Template Application Features
+
+*Provide a comprehensive description of your application, including figures showing the application. You can learn more on how to structure a README in the [Stanford Spezi Documentation Guide](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/documentation-guide)*
+
+
+## Contributing
+
+*Ensure that you add an adequate contribution section to this README.*
+
+
+## License
+
+This project is licensed under the MIT License. See [Licenses](LICENSES) for more information.

Scripts/create.sh

@@ -125,8 +125,11 @@ projectNameSpeziEscaped=$(sed 's:/:\\/:g' <<< "Spezi Template Application")
 projectNameEscaped=$(sed 's:/:\\/:g' <<< "Template Application")
 templateEscaped=$(sed 's:/:\\/:g' <<< "Template")
 
-# appNameEscaped=$(sed 's:/:\\/:g' <<< "$appName based on the Stanford Spezi Template Application")
-appNameEscaped=$(sed 's:/:\\/:g' <<< "$appName")
+sstaEscaped=$(sed 's:/:\\/:g' <<< "SSTA")
+taEscaped=$(sed 's:/:\\/:g' <<< "TA")
+sstaFullEscaped=$(sed 's:/:\\/:g' <<< "Stanford Spezi Template Application")
+taFullEscaped=$(sed 's:/:\\/:g' <<< "Template Application")
+appNameEscaped=$(sed 's:/:\\/:g' <<< "$appName based on the $sstaEscaped")
 appNameNoSpacesEscaped=$(sed 's:/:\\/:g' <<< "$appNameNoSpaces")
 
 find . -type f -not \( -path '*/.git/*' \) -not \( -path '*/Scripts/create.sh' \) -exec grep -Iq . {} \; -print | while read -r file; do
@@ -136,6 +139,8 @@ find . -type f -not \( -path '*/.git/*' \) -not \( -path '*/Scripts/create.sh' \
     sed -i '' "s/${projectNameSpeziEscaped}/${appNameEscaped}/g" "$file" || echo "Failed to process $file"
     sed -i '' "s/${projectNameEscaped}/${appNameEscaped}/g" "$file" || echo "Failed to process $file"
     sed -i '' "s/${templateEscaped}/${appNameNoSpacesEscaped}/g" "$file" || echo "Failed to process $file"
+    sed -i '' "s/${sstaEscaped}/${sstaFullEscaped}/g" "$file" || echo "Failed to process $file"
+    sed -i '' "s/${taEscaped}/${taFullEscaped}/g" "$file" || echo "Failed to process $file"
 done
 
 # Remove the repo link and DOI from the citation file:
@@ -179,3 +184,8 @@ find . -type f -name "*${projectNameNoSpacesEscaped}*" | while read -r file; do
         mv "$file" "$new_file"
     fi
 done
+
+# Remove the DocC documentation, Figures, and replace the README with a placeholder README
+rm -rf "./${appNameNoSpacesEscaped}/Supporting Files/${appNameNoSpacesEscaped}.docc"
+mv "./Scripts/TEMPLATEREADME.md" "./README.md"
+rm -rf "./Scripts"

TemplateApplication/Supporting Files/TemplateApplication.docc/TemplateApplication.md

@@ -14,7 +14,7 @@ Template to provide a starting point for Spezi-based applications.
 
 ## Overview
 
-The Spezi Template Application demonstrates using the [Spezi](https://github.com/StanfordSpezi/Spezi) framework template and builds on top of the [Stanford Biodesign Digital Health Template Application](https://github.com/StanfordBDHG/TemplateApplication).
+The Spezi Template Application demonstrates using the [Spezi](https://github.com/StanfordSpezi/Spezi) ecosystem and builds on top of the [Stanford Biodesign Digital Health Template Application](https://github.com/StanfordBDHG/TemplateApplication).
 
 > Tip: Do you want to try out the Spezi Template Application? You can download it to your iOS device using [TestFlight](https://testflight.apple.com/join/ipEezBY1)!