From a8797f16c19fa69a9ea82ca290d54b60172f1b26 Mon Sep 17 00:00:00 2001 From: angrezichatterbox Date: Tue, 27 Jan 2026 11:25:53 +0530 Subject: [PATCH 1/2] feat:add build instructions for changing targets --- CONTRIBUTING.md | 19 +++++++++++++++++-- README.md | 13 +++++++++++++ 2 files changed, 30 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e2aef405..eed14787 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -126,7 +126,9 @@ pre-commit install 4. Open the Scribe-iOS directory in Xcode -5. In order to run Scribe on an emulator: +5. The application has mainly 2 build schemes, Conjugate and Scribe for the Conjugate and the whole keyboard application. There are other build schemes for individual keyboard which need not be worried about. More about this could be read at [here](#build-scheme) + +6. In order to run Scribe on an emulator: - Read the [documentation from Apple](https://developer.apple.com/documentation/xcode/running-your-app-in-the-simulator-or-on-a-device) if need be - In the top bar select Scribe as the scheme @@ -152,8 +154,21 @@ The Xcode debugger often doesn't work as expected for Scribe as the keyboards th - When you get a window telling you to "choose an app to run", don't choose Scribe as you might expect, but instead scroll down and select Xcode Previews - Occasionally you'll be met with just a black screen on startup, in which case you can press Home (or ⇧-⌘-H) and then go directly to Scribe or an app for keyboard testing - + + + +## Build Schemes Selection [`⇧`](#contents) + +The project includes mainly two build schemes, each corresponding to a different application.There are other targets corresponding to the indiviudal keyboards which is shipped within the `Scribe` target. + +Build schemes can be selected from the top bar next to device selection. + +1. Scribe → Scribe Language Keyboards app (IME) +2. Conjugate → Scribe Conjugate verb conjugation app + + + ## Testing [`⇧`](#contents) Writing unit tests is essential to guarantee the dependability and sustainability of the Scribe-iOS codebase. Unit tests confirm that individual components of the application work as intended by detecting errors at an early stage, thus making the debugging process easier and boosting assurance for upcoming modifications. An unchanging testing method helps new team members grasp project norms and anticipated actions. diff --git a/README.md b/README.md index a7f54dcb..22cb867c 100644 --- a/README.md +++ b/README.md @@ -198,6 +198,19 @@ pre-commit install # App Setup [`⇧`](#contents) +### Codebase Overview + +The Scribe-iOS codebase consists of two separate applications. + +- Keyboard Application — the Scribe Language Keyboards application (IME) + +- Conjugate Application — the Scribe verb conjugations application + +To select each variant you should select the scheme from the top bar next to device selection. + +1. Scribe - Keyboard application +2. Conjugate - Conjugate Output + Users access Scribe language keyboards through the following: - Download **Scribe - Language Keyboards** from the [App Store](https://apps.apple.com/app/scribe-language-keyboards/id1596613886) From f94f5bc21568598d613333b2ec2419070723fe74 Mon Sep 17 00:00:00 2001 From: Andrew Tavis McAllister Date: Tue, 27 Jan 2026 08:57:32 +0100 Subject: [PATCH 2/2] Minor edits and update TOCs for docs md files --- CONTRIBUTING.md | 16 ++++++++-------- README.md | 14 ++++++++------ 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eed14787..ec572ee1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,6 +16,7 @@ If you have questions or would like to communicate with the team, please [join u - [Learning the tech stack](#learning-the-tech) - [Development environment](#dev-env) - [Note on debugging](#note-on-debugging) +- [Build Schemes Selection](#build-scheme) - [Testing](#testing) - [Issues and projects](#issues-projects) - [Bug reports](#bug-reports) @@ -126,10 +127,11 @@ pre-commit install 4. Open the Scribe-iOS directory in Xcode -5. The application has mainly 2 build schemes, Conjugate and Scribe for the Conjugate and the whole keyboard application. There are other build schemes for individual keyboard which need not be worried about. More about this could be read at [here](#build-scheme) +5. The application has 2 build schemes, Conjugate and Scribe for the verb conjugation and the language keyboards applications + - There are other build schemes for individual keyboard which don't need to be selected unless you're trying to debug a keyboard + - More about this could be read in the [Build Schemes Selection](#build-scheme) section 6. In order to run Scribe on an emulator: - - Read the [documentation from Apple](https://developer.apple.com/documentation/xcode/running-your-app-in-the-simulator-or-on-a-device) if need be - In the top bar select Scribe as the scheme - If you're debugging you'll need to select the keyboard you're testing as the scheme (see the [note on debugging](#note-on-debugging) below) @@ -137,7 +139,7 @@ pre-commit install - Press the run button marked `Start the active scheme` - From here code edits that are made will be reflected in the app each time the active scheme is restarted -6. Build the developer documentation by selecting `Product` > `Build Documentation` (^⇧⌘D) +7. Build the developer documentation by selecting `Product` > `Build Documentation` (^⇧⌘D) > [!NOTE] > Feel free to contact the team in the [iOS room on Matrix](https://matrix.to/#/#ScribeiOS:matrix.org) if you're having problems getting your environment setup! @@ -154,21 +156,19 @@ The Xcode debugger often doesn't work as expected for Scribe as the keyboards th - When you get a window telling you to "choose an app to run", don't choose Scribe as you might expect, but instead scroll down and select Xcode Previews - Occasionally you'll be met with just a black screen on startup, in which case you can press Home (or ⇧-⌘-H) and then go directly to Scribe or an app for keyboard testing - - ## Build Schemes Selection [`⇧`](#contents) -The project includes mainly two build schemes, each corresponding to a different application.There are other targets corresponding to the indiviudal keyboards which is shipped within the `Scribe` target. +The project includes two build schemes, each corresponding to a different application.There are other targets corresponding to the individual keyboards which are shipped within the `Scribe` target. -Build schemes can be selected from the top bar next to device selection. +Build schemes can be selected from the top bar next to device selection. 1. Scribe → Scribe Language Keyboards app (IME) 2. Conjugate → Scribe Conjugate verb conjugation app - + ## Testing [`⇧`](#contents) Writing unit tests is essential to guarantee the dependability and sustainability of the Scribe-iOS codebase. Unit tests confirm that individual components of the application work as intended by detecting errors at an early stage, thus making the debugging process easier and boosting assurance for upcoming modifications. An unchanging testing method helps new team members grasp project norms and anticipated actions. diff --git a/README.md b/README.md index 22cb867c..19619e2d 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,7 @@ Check out Scribe's [architecture diagrams](https://github.com/scribe-org/Organiz - [Contributing](#contributing) - [Environment Setup](#environment-setup) - [App Setup](#app-setup) + - [Codebase Overview](#codebase-overview) - [Supported Languages](#supported-languages) - [Keyboard Features](#keyboard-features) - [Featured By](#featured-by) @@ -177,7 +178,6 @@ pre-commit install 4. Open the Scribe-iOS directory in Xcode 5. In order to run Scribe on an emulator: - - Read the [documentation from Apple](https://developer.apple.com/documentation/xcode/running-your-app-in-simulator-or-on-a-device) if need be - In the top bar select Scribe as the scheme - If you're debugging you'll need to select the keyboard you're testing as the scheme (see the [note on debugging](#note-on-debugging) below) @@ -198,18 +198,20 @@ pre-commit install # App Setup [`⇧`](#contents) -### Codebase Overview + + +### Codebase Overview -The Scribe-iOS codebase consists of two separate applications. +The Scribe-iOS codebase consists of two separate applications. - Keyboard Application — the Scribe Language Keyboards application (IME) - Conjugate Application — the Scribe verb conjugations application -To select each variant you should select the scheme from the top bar next to device selection. +To select each variant you should select the scheme from the top bar next to device selection. -1. Scribe - Keyboard application -2. Conjugate - Conjugate Output +1. Scribe → Scribe Language Keyboards app (IME) +2. Conjugate → Scribe Conjugate verb conjugation app Users access Scribe language keyboards through the following: