From 4baf2e4ca359a7a0010730639ab243d65cbac890 Mon Sep 17 00:00:00 2001 From: Russell Keith-Magee Date: Sat, 19 Oct 2024 08:55:45 +0800 Subject: [PATCH] Add documentation about git-lfs requirement. --- README.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index a001b9c..4404ad3 100644 --- a/README.rst +++ b/README.rst @@ -12,12 +12,17 @@ Usage This repo contains an activation script that will configure your environment so it's ready to use. To set up a build environment: -1. Clone this repository:: +1. Ensure you have ``git-lfs`` installed (``git lfs --version`` should return a + version number, not an error). ``git-lfs`` is available from + `https://git-lfs.com `_, or by running ``brew install + git-lfs``. + +2. Clone this repository:: $ git clone https://github.com/beeware/mobile-forge.git $ cd mobile-forge -2. Run the script for the Python version you want to use, providing the support +3. Run the script for the Python version you want to use, providing the support revision:: $ source ./setup-iOS.sh 3.11