Skip to content

Commit 9bd8d9c

Browse files
committed
minor updates
1 parent 685aeb4 commit 9bd8d9c

File tree

2 files changed

+35
-20
lines changed

2 files changed

+35
-20
lines changed

docs/browser/edit-browser.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
1. Make the desired modification(s) using the pencil tool
5252
1. Save your changes to a patch branch
5353
1. Prepare lines needed for each customization and save
54-
* New with 3.4.x release, there are 2 ways to add customizations
54+
* New with 3.4.x release, there are 2 ways to add customizations (use only one)
5555
* See [Update LoopWorkspace](#updateloopworkspace){: target="_blank" }
5656
* See [How to use the `patches` Folder](#how-to-use-the-patches-folder){: target="_blank" }
5757
* Regardless of the method, incorporate the customization with `Action 4: Build Loop`
@@ -187,7 +187,7 @@ When you&nbsp;"<span translate="no">fork a repository"</span>, the default&nbsp;
187187
??? abstract "Use only if directed (Click to Open/Close)"
188188
Open your browser to your https://github.com/username/Module URL. If you already created the `branch` you need, you do not need to create a new one.
189189

190-
If you are customizing a released version, use the [Table of SHA-1](#table-of-sha-1) under your version number below. Copy the SHA-1 for your Module so you can paste it into the URL in Step 2 below. Notice the suggested branch name for that table. You will use this in Step 3.3 below.
190+
If you are customizing a released version, use the [Table of SHA-1](#table-of-sha-1) under your version number below. Copy the SHA-1 for your Module so you can paste it into the URL in Step 2 below. The suggested branch name is `v-#.#.#` where #.#.# corresponds to the version number for `main`. You will use this in Step 3.3 below.
191191

192192
You should create a `branch` following the numbered steps and watching the GIF. Each Frame in the GIF corresponds to a numbered step below.
193193

@@ -274,15 +274,19 @@ There are 4 frames shown in this GIF; the frame number is noted at the bottom ri
274274

275275
* **Frame 2 shows a `Pull Request` to your own repository - that is OK**
276276

277-
* Frame 3 displays a green button that would make a `Pull Request` to a `LoopKit/repository` - **do NOT click that button**
277+
* Frame 3 displays a green `Compare & pull request` button that would make a `Pull Request` to a `LoopKit/repository` - **do NOT click that button**
278278

279-
* Frame 4 shows how to obtain the really-long alphanumeric string needed to modify your build_loop.yml file
279+
* Frame 4 shows how to obtain the really-long alphanumeric string (SHA-1) needed to modify your build_loop.yml file
280280

281281
![GitHub screen while creating a customization](img/browser-customize.gif){width="750"}
282282
{align="center"}
283283

284284
### Detailed Instructions
285285

286+
If you followed along above and made the modifations, you can skip ahead to [Prepare the Customizations](#prepare-the-customizations).
287+
288+
This section provides the detailed steps just explained in [Example GIF](#example-gif).
289+
286290
You will be using the "pencil" tool in the browser display for your <code>fork</code>.
287291

288292
!!! question "Are there detailed instructions?"
@@ -379,6 +383,8 @@ To view the exact code change associated with that patch, open a browser at the
379383

380384
## Update&nbsp;<span translate="no">LoopWorkspace</span>
381385

386+
With the release of 3.4.x, there are two ways to use this customization. Keep reading for the method in which you edit the build_loop.yml file. If you are feeling adventurous, check out [How to use the `patches` Folder](#how-to-use-the-patches-folder){: target="_blank" }.
387+
382388
The final step is to update your&nbsp;<span translate="no">LoopWorkspace fork</span>&nbsp;to apply these customizations by adding those customization lines into the build_loop.yml file.
383389

384390
Return to your&nbsp;<span translate="no">GitHub fork for LoopWorkspace</span>&nbsp;and make sure to sync it if needed.
@@ -480,7 +486,12 @@ Refer to [Prepare customization lines](#prepare-customization-lines){: target="_
480486

481487
Now you need to download that file (Save Page As, if using chrome).
482488

483-
Once the file is downloaded to a sensible name, make a copy (or rename it) to indicate that you have edited the file to make it a Workspace level patch. An example is shown below. You add the name of the submodule in 4 places so the patch is applied correctly when you build.
489+
Once the file is downloaded to a sensible name, make a copy (or rename it) to indicate that you have edited the file to make it a Workspace level patch. An example is shown below.
490+
491+
* Top file shows the original download
492+
* Lower file shows the renamed and edited version:
493+
* Add the name of the module to the "a" and "b" directory paths so the patch is applied to the correct folder (from LoopWorkspace)
494+
* In this example `OmniBLE/` was added in 4 places as highlighted by red rectangles
484495

485496
![download and then edit patch for Workspace](img/prepare-workspace-patch.svg){width="750"}
486497
{align="center"}

docs/browser/img/prepare-workspace-patch.svg

Lines changed: 19 additions & 15 deletions
Loading

0 commit comments

Comments
 (0)