You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-19Lines changed: 11 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,45 +51,37 @@ Repository Contents
51
51
***/Firmware** - Source code for SparkFun RTK firmware as well as various feature unit tests
52
52
***/Graphics** - Original bitmap icons for the display
53
53
***/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).
54
55
***/docs** - Markdown pages for the [RTK Product Manual](https://sparkfun.github.io/SparkFun_RTK_Firmware/intro/)
55
56
56
57
Repository Branch Structure
57
58
---------------------------
58
59
59
60
This repository has two long-term branches: `main` and `release_candidate`.
60
61
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.
65
63
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.
68
65
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.
73
67
74
68
Release Process
75
69
---------------
76
70
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`.
79
72
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.
82
74
83
75
Building from Source
84
76
--------------------
85
77
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).
89
79
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).
91
81
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)
0 commit comments