docs: tuist setup

square · Dec 2, 2024 · 6b7d087 · 6b7d087
1 parent d4265d4
commit 6b7d087
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -25,6 +25,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Internal
 
+- Local development environment switched from CocoaPods to Tuist.
+
 ## [5.1.0] - 2024-11-25
 
 ### Added

diff --git a/README.md b/README.md
@@ -113,6 +113,26 @@ target MyTarget do
 end
 ```
 
+## Local Development
+
+This project uses [Mise](https://mise.jdx.dev/) and [Tuist](https://tuist.io/) to generate a project for local development. Follow the steps below for the recommended setup for zsh.
+
+```sh
+# install mise
+brew install mise
+# add mise activation line to your zshrc
+echo 'eval "$(mise activate zsh)"' >> ~/.zshrc
+# load mise into your shell
+source ~/.zshrc
+# install dependencies
+mise install
+
+# only necessary for first setup or after changing dependencies
+tuist install --path SampleApp
+# generates and opens the Xcode project
+tuist generate --path SampleApp
+```
+
 ---
 
 [Release instructions](./RELEASING.md)