Improve README style

main
Nathan L. Conrad 5 years ago
parent 7518794803
commit ed63f233a2

@ -1,19 +1,29 @@
bgtex
BGTEX schematic and PCB design
A low-cost BLE prototyping module with a small footprint and big Texan ambition
FEATURES
- Silicon Labs BGM220P Wireless Gecko Bluetooth Module
- 20-pin 100mil-pitch through-hole footprint for a straight or angled, front
or back-mounted header/socket
- Mini Simplicity and Tag-Connect debug connectors
- SOIC/WSON-8 SPI flash
- Texas Instruments TPS22917 load switch to control SPI peripheral power
DEPENDENCIES
- KiCad version 5.1.6 for macOS. Results with previous or subsequent versions
will likely vary.
- KiCad version 5.1.6 for macOS. Results with previous or subsequent
versions will likely vary.
- kipy (https://git.alt-tek.com/alt-tek/kipy) is useful to simplify executing
scripts with KiCad's Python environment. It is required to generate board
plots with plot.py for releases.
- tea (https://gitea.com/gitea/tea) is required to generate releases. Install
and write your API token to ~/.config/git.alt-tek.com/api-token. Restrict
access to your API token by setting its file permissions accordingly
(i.e. 'chmod 600 ~/.config/git.alt-tek.com/api-token').
- tea (https://gitea.com/gitea/tea) is required to generate releases.
Install and write your API token to ~/.config/git.alt-tek.com/api-token.
Restrict access to your API token by setting its file permissions
accordingly (i.e. 'chmod 600 ~/.config/git.alt-tek.com/api-token').
- In order to generate releases, SSH must be configured for git.alt-tek.com
such that SSH Git commands can be executed without explicitly specifying an
SSH identity or private key
@ -23,8 +33,8 @@ RELEASING
1. See above dependencies
2. Create an annotated Git tag for the release commit using
"git tag -a v<version> -m 'Version <version>' <commit>" where version is the
board version in X.Y.Z form and <commit> is the commit hash
"git tag -a v<version> -m 'Version <version>' <commit>" where version is
the board version in X.Y.Z form and <commit> is the commit hash
(e.g. "git tag -a v1.2.3 -m 'Version 1.2.3' d15c0cafe")
3. Push the tag upstream (i.e. 'git push origin tags/v<version>')
4. Use the release script to build the release and upload it as a draft

Loading…
Cancel
Save