Skip to content

Commit 2f51887

Browse files
committed
Fix todos. Add u-blox_update_GUI folder.
1 parent d024dec commit 2f51887

File tree

1 file changed

+11
-19
lines changed

1 file changed

+11
-19
lines changed

README.md

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -51,45 +51,37 @@ Repository Contents
5151
* **/Firmware** - Source code for SparkFun RTK firmware as well as various feature unit tests
5252
* **/Graphics** - Original bitmap icons for the display
5353
* **/Uploader_GUI** - A python and Windows executable GUI for updating the firmware on RTK units. See [Updating Firmware From GUI](https://sparkfun.github.io/SparkFun_RTK_Firmware/firmware_update/#updating-firmware-from-gui).
54+
* **/u-blox_Update_GUI** - A python and Windows executable GUI for updating the firmware on the u-blox modules within the RTK device (ZED-F9x and NEO-D9S primarily but all u-blox GNSS products are supported). See [Updating u-blox Firmware](https://sparkfun.github.io/SparkFun_RTK_Firmware/firmware_update/#zed-f9x-firmware).
5455
* **/docs** - Markdown pages for the [RTK Product Manual](https://sparkfun.github.io/SparkFun_RTK_Firmware/intro/)
5556

5657
Repository Branch Structure
5758
---------------------------
5859

5960
This repository has two long-term branches: `main` and `release_candidate`.
6061

61-
With respect to the firmware, and probably the Uploader GUI, main is a
62-
branch where only changes that are appropriate for all users are
63-
applied. Thus, following `main` means updating to formal releases,
64-
and perhaps bugfixes to those releases.
62+
With respect to the firmware, `main` is a branch where only changes that are appropriate for all users are applied. Thus, following `main` means updating to normal releases, and perhaps bugfixes to those releases.
6563

66-
In contrast, `release_candidate` is a branch that might have been
67-
called `develop`, where new code is added as it is developed.
64+
In contrast, `release_candidate` is where new code is added as it is developed.
6865

69-
Documentation is handled differently. The documentation source code
70-
is in docs/ on `main`. It is built automatically on push and stored
71-
in the branch `gh-pages`, from which it is served at the above URL.
72-
\todo Describe how and if docs are merged from `main` to `release_candidate`.
66+
The documentation source code is in docs/ on `main`. It is built automatically on push and stored in the branch `gh-pages`, from which it is served at the above URL. Documentation changes are pushed directly to main.
7367

7468
Release Process
7569
---------------
7670

77-
A release is made by merging `release_candidate` back to `main`, and
78-
then applying a tag to that commit on `main`.
71+
A release is made by merging `release_candidate` back to `main`, and then applying a tag to that commit on `main`.
7972

80-
\todo Describe how the firmare is built from the tag and then
81-
committed to `main`, or if something else happens.
73+
A pre-release is often created using the latest stable release candidate. These binaries will have extra debug statements turned on that will not be present in a formal release, but should not affect behavior of the firmware.
8274

8375
Building from Source
8476
--------------------
8577

86-
This repository contains a number of subdirectories which are mostly
87-
independent. For building the firmware, see the [Firmware
88-
README](Firmware/readme.md).
78+
For building the firmware, see the [Firmware README](Firmware/readme.md).
8979

90-
For the documention, see `.github/workflows/mkdocs.yml`.
80+
For the documention, see [mkdocs.yml](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/main/mkdocs.yml) and [/workflows/mkdocs.yml](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/main/.github/workflows/mkdocs.yml).
9181

92-
\todo Building the `Uploader_GUI` and the `u-blox_Update_GUI` is not documented.
82+
For building the Uploader_GUI see the header comments of [RTK_Firkware_Uploader_GUI.py](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/main/Uploader_GUI/RTK_Firmware_Uploader_GUI.py)
83+
84+
For building the u-blox_Update_GUI see the header comments of [RTK_u-blox_Update_GUI.py](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/main/u-blox_Update_GUI/RTK_u-blox_Update_GUI.py)
9385

9486
License Information
9587
-------------------

0 commit comments

Comments
 (0)