From 6b7d087aca628c8e6c700d8566dece7c796a8726 Mon Sep 17 00:00:00 2001 From: Andrew Watt <awatt@squareup.com> Date: Mon, 2 Dec 2024 15:04:37 -0800 Subject: [PATCH] docs: tuist setup --- CHANGELOG.md | 2 ++ README.md | 20 ++++++++++++++++++++ 2 files changed, 22 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 61564a628..35d8afc62 100644 --- 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 index b4207d636..8ea7d6016 100644 --- 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)