Release v0.2.0

CHANGELOG.md

@@ -6,6 +6,21 @@ file. This change log follows the conventions of
 
 ## [Unreleased]
 
+### Added
+
+- SkyDemon documentation
+- Garmin Pilot documentation
+
+### Changed
+
+- Rename "Broadcast subnet mask" to "Broadcast address" and add an explanation for how it works
+
+### Fixed
+
+- Fix the issue that is causing the broadcast to happen on the "255.255.255.255" netmask, irrespective of what is configured in the UI
+- Fix the text input mask of "Broadcast address"
+- Fix the issue that is causing the check for a new version to happen more often than needed
+
 ## [v0.1.0] - 2020-12-26
 
 ### Initial Release of MSFS 2020 GPS Link

CONTRIBUTING.md

@@ -0,0 +1,76 @@
+# Contributing
+
+Contributions are welcome and encouraged!
+
+## Development
+
+Clone the repo
+
+```bash
+git clone https://github.com/mihai-dinculescu/msfs-2020-gps-link.git
+```
+
+Start msfs-2020-gps-link in dev mode
+
+```bash
+cd msfs-2020-gps-link
+yarn tauri dev
+```
+
+### Releases
+
+- Update version in `msfs-2020-gps-link\src-tauri\Cargo.toml`
+- Update version in `msfs-2020-gps-link\package.json`
+- Update `version.txt`
+- Commit
+- Add tag
+
+```bash
+git tag -a vX.X.X
+```
+
+- Push
+
+```bash
+git push --follow-tags
+```
+
+- Build a new installer
+
+```bash
+yarn tauri build
+```
+
+The new installer can be found in `msfs-2020-gps-link\msfs-2020-gps-link\src-tauri\target\release\bundle\msi`.
+
+- Create the release and publish the installer archive
+
+### Troubleshooting
+
+### 1. Tauri `target` path
+
+Tauri doesn't currently handle Rust workspaces very well. The following workaround is needed in order to make it successfully build the release bundle
+
+msfs-2020-gps-link/.cargo/config
+
+```toml
+[build]
+target-dir = "<full-path-to-project>/msfs-2020-gps-link/src-tauri/target"
+```
+
+## Tracing
+
+Spin up Jaeger
+
+```bash
+docker run -d -p6831:6831/udp -p6832:6832/udp -p16686:16686 -p14268:14268 jaegertracing/all-in-one:latest
+```
+
+Start msfs-2020-gps-link in dev mode
+
+```bash
+cd msfs-2020-gps-link
+RUST_LOG=info yarn tauri dev
+```
+
+Browse the Jaeger traces at http://localhost:16686.

README.md

@@ -32,52 +32,7 @@ Scroll to the bottom and you should see `SIMULATOR STATUS` showing an `amber`sta
 
 # Contributing
 
-Contributions are welcome and encouraged!
-
-## Development
-
-Clone the repo
-
-```bash
-git clone https://github.com/mihai-dinculescu/msfs-2020-gps-link.git
-```
-
-Start msfs-2020-gps-link in dev mode
-
-```bash
-cd msfs-2020-gps-link
-yarn tauri dev
-```
-
-### Troubleshooting
-
-### 1. Tauri `target` path
-
-Tauri doesn't currently handle Rust workspaces very well. The following workaround is needed in order to make it successfully build the release bundle
-
-msfs-2020-gps-link/.cargo/config
-
-```toml
-[build]
-target-dir = "<full-path-to-project>/msfs-2020-gps-link/src-tauri/target"
-```
-
-## Tracing
-
-Spin up Jaeger
-
-```bash
-docker run -d -p6831:6831/udp -p6832:6832/udp -p16686:16686 -p14268:14268 jaegertracing/all-in-one:latest
-```
-
-Start msfs-2020-gps-link in dev mode
-
-```bash
-cd msfs-2020-gps-link
-RUST_LOG=info yarn tauri dev
-```
-
-Browse the Jaeger traces at http://localhost:16686.
+Contributions are welcome and encouraged! Please read [Contributing.md][contributing_url]
 
 [latest_release_badge]: https://img.shields.io/github/release/mihai-dinculescu/msfs-2020-gps-link.svg
 [downloads_badge]: https://img.shields.io/github/downloads/mihai-dinculescu/msfs-2020-gps-link/total.svg
@@ -88,3 +43,4 @@ Browse the Jaeger traces at http://localhost:16686.
 [usage]: https://github.com/mihai-dinculescu/msfs-2020-gps-link/blob/main/assets/usage.PNG
 [usage_skydemon]: https://github.com/mihai-dinculescu/msfs-2020-gps-link/blob/main/assets/usage-skydemon.PNG
 [usage_garmin_pilot]: https://github.com/mihai-dinculescu/msfs-2020-gps-link/blob/main/assets/usage-garmin-pilot.PNG
+[contributing_url]: /Contributing.md

msfs-2020-gps-link/package.json

@@ -1,6 +1,6 @@
 {
   "name": "msfs-2020-gps-link",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "private": true,
   "scripts": {
     "start": "react-app-rewired start",
@@ -42,6 +42,7 @@
   },
   "dependencies": {
     "@material-ui/core": "^4.11.3",
+    "@material-ui/icons": "^4.11.2",
     "@material-ui/lab": "^4.0.0-alpha.57",
     "react": "^17.0.1",
     "react-dom": "^17.0.1",

msfs-2020-gps-link/src-tauri/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "MSFS-2020-GPS-Link"
-version = "0.1.0"
+version = "0.2.0"
 authors = [ "Mihai Dinculescu <[email protected]>" ]
 edition = "2018"
 description = "MSFS 2020 GPS Link"

version.txt

@@ -1 +1 @@
-0.1.0
+0.2.0