Skip to content

Commit dfce4e2

Browse files
committed
Add repository structure to readme
Refactored the repository with tags/semantic versioning and needed explanation
1 parent 1e80063 commit dfce4e2

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,22 @@ For more on how config files work see the [mbed OS docs](https://docs.mbed.com/d
8989
- AnalogIn pins must also support DigitalOut
9090
- Tests require mbed-cli version > 0.9.9 .
9191

92+
## Repository structure
93+
The latest version of the hardware and software is available on `master`. Development should not occur on this branch - all development should be done on the corresponding hardware branches. Only commits tagged for production will be moved over to master.
94+
95+
Each version of the hardware has its' own branch.
96+
* `HW0` - Board identity: `0.1.0`. Original hardware board.
97+
* `HW1` - Board identity: `1.0.0`. Revamped version of HW0 which has PCB resistors, new EEPROM chip.
98+
* `HW2` - Board identity: `2,0,0`. Latest and greatest, removed UART resistors. Updated FLASH.
99+
100+
Developement should take place on the latest hardware branch. Currently that hardware branch is `HW2`. When a feature is approved and tested, the hardware branch will get tagged and merged into master.
101+
102+
Release numbers are also now in effect. Tags are using the [semantic versioning model](http://semver.org/).
103+
X.Y.Z
104+
* X: Hardware version. Software for each hardware version are incompatible with previous hardware versions
105+
* Y: Feature. New features increment the minor number
106+
* Z: Patch
107+
92108
## More information
93109
For more information see the [Releases](https://github.com/ARMmbed/ci-test-shield/releases) page.
94110

0 commit comments

Comments
 (0)