Merge #141

141: 0.10.0 release preparation r=adamgreig a=Yatekii Co-authored-by: Noah Hüsser <[email protected]> Co-authored-by: Yatekii <[email protected]> Co-authored-by: Noah Hüsser <[email protected]>
probe-rs · Nov 19, 2020 · 8a4c101 · 8a4c101
2 parents d4d5b02 + d7c7fd8
commit 8a4c101
Show file tree

Hide file tree

Showing 6 changed files with 103 additions and 92 deletions.
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1 @@
+github: [probe-rs]
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+## [0.10.0]
+
+### Added
+
+- Updated to probe-rs 0.10.0. Please consult its own changelog for new features and fixes.
+- Added logging to sentry.io. This is 100% OPT-IN! You will be asked only if an unhandled error or panic occurs, and only if you give consent, data is transmitted. If you do not trust us either way, you can disable the `sentry` feature when you install the crate. The completely anonymous data can be investigated on sentry.io by anyone who likes to see it. Unfortunately sentry.io does not feature public orgs yet, so please reach out to @Yatekii to be added.
+Sentry helps us track down tricky issues that only occur in very specific cases. It is very much appreciated if you log upcoming errors this way (#125)!
+- Added printing of the git hash cargo-embed was compiled with and the current package version (#116).
+
+### Changed
+
+- FTDI support is now optional. To enable FTDI support, please use the `ftdi` feature (#131).
+
 ## [0.9.1]
 
 ### Added
@@ -133,10 +146,11 @@ An example is this config:
 ## [0.6.0]
 - Initial release
 
-[Unreleased]: https://github.com/probe-rs/probe-rs/compare/v0.9.1...master
-[0.9.1]: https://github.com/probe-rs/probe-rs/releases/tag/v0.9.1..v0.9.0
-[0.9.0]: https://github.com/probe-rs/probe-rs/releases/tag/v0.9.0..v0.8.0
-[0.8.0]: https://github.com/probe-rs/probe-rs/releases/tag/v0.8.0..v0.7.0
-[0.7.0]: https://github.com/probe-rs/probe-rs/releases/tag/v0.7.0..v0.6.1
-[0.6.1]: https://github.com/probe-rs/probe-rs/releases/tag/v0.6.1..v0.6.0
-[0.6.0]: https://github.com/probe-rs/probe-rs/releases/tag/v0.6.0
+[Unreleased]: https://github.com/probe-rs/cargo-embed/compare/v0.10.0..master
+[0.10.0]: https://github.com/probe-rs/cargo-embed/releases/tag/v0.9.0..v0.10.0
+[0.9.1]: https://github.com/probe-rs/cargo-embed/releases/tag/v0.9.0..v0.9.1
+[0.9.0]: https://github.com/probe-rs/cargo-embed/releases/tag/v0.8.0..v0.9.0
+[0.8.0]: https://github.com/probe-rs/cargo-embed/releases/tag/v0.7.0..v0.8.0
+[0.7.0]: https://github.com/probe-rs/cargo-embed/releases/tag/v0.6.1..v0.7.0
+[0.6.1]: https://github.com/probe-rs/cargo-embed/releases/tag/v0.6.0..v0.6.1
+[0.6.0]: https://github.com/probe-rs/cargo-embed/releases/tag/v0.6.0
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "cargo-embed"
-version = "0.9.1"
+version = "0.10.0"
 authors = ["Noah Hüsser <[email protected]>"]
 edition = "2018"
 description = "A utility to develop software for embedded ARM and RISC-V cores."
@@ -18,9 +18,9 @@ ftdi = ["probe-rs/ftdi"]
 sentry = ["probe-rs-cli-util/sentry"]
 
 [dependencies]
-probe-rs = { version = "0.9.0", git = "https://github.com/probe-rs/probe-rs" }
-gdb-server = { version = "0.9.0", git = "https://github.com/probe-rs/probe-rs"  }
-probe-rs-cli-util = { version = "0.9.0", git = "https://github.com/probe-rs/probe-rs", default-features = false }
+probe-rs = { version = "0.10.0", git = "https://github.com/probe-rs/probe-rs" }
+gdb-server = { version = "0.10.0", git = "https://github.com/probe-rs/probe-rs"  }
+probe-rs-cli-util = { version = "0.10.0", git = "https://github.com/probe-rs/probe-rs", default-features = false }
 
 structopt = "0.3.18"
 git-version = "0.3.4"
@@ -32,14 +32,11 @@ colored = "2.0.0"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = { version = "1.0.51" }
 config = { version = "0.10.1", features = ["toml", "json", "yaml"], default-features = false }
-probe-rs-rtt = { version = "0.4.0" }
+probe-rs-rtt = { version = "0.10.0", git = "https://github.com/probe-rs/probe-rs-rtt" }
 chrono = "0.4"
 # Version 0.17.8 doesn't compile on Windows
 crossterm = "<= 0.17.7"
 goblin = "0.2.0"
 tui = { version = "0.12.0", default-features = false, features = ["crossterm"] }
 anyhow = "1.0.31"
 textwrap = "0.12.1"
-
-[patch.crates-io]
-probe-rs = { version = "0.9.0", git = "https://github.com/probe-rs/probe-rs" }
diff --git a/README.md b/README.md
@@ -9,6 +9,10 @@ It can flash targets, just like cargo-flash but can do much more, such as loggin
 Various chip families including but not limited to nRF5x, STM32 and LPC800 can be worked with using DAPLink, ST-Link or J-Link.
 It supports all the targets & probes [probe-rs](https://github.com/probe-rs/probe-rs) supports.
 
+## Support
+
+If you think cargo-embedded makes your embedded journey more enjoyable or even earns you money, please consider supporting the project on [Github Sponsors](https://github.com/sponsors/probe-rs/) for better support and more features.
+
 ## Installation
 
 You can install this utility with cargo:
@@ -45,6 +49,48 @@ Instead of a TOML file, you can also use a JSON or YAML file. Choose what suits
 
 You can find all available options in the [default.toml](src/config/default.toml). Commented out options are the ones that are `None` by default.
 
+## Building
+
+`cargo-embed` can be built using cargo, after installing the necessary prerequisites. See the list below for your operating
+system.
+
+### FTDI Support
+
+FTDI support is optional. You can enable it with the `ftdi` feature. You also need the correct prerequisites from the next section installed.
+
+### Prerequisites
+
+cargo-embed depends on the [libusb](https://libusb.info/) and optionally on [libftdi](https://www.intra2net.com/en/developer/libftdi/) libraries, which need to be installed to build cargo-embed.
+
+#### Linux
+
+On Ubuntu, the following packages need to be installed:
+
+```
+> sudo apt install -y pkg-config libusb-dev libusb-1.0 libftdi1-dev
+```
+
+#### Windows
+
+On Windows you can use [vcpkg](https://github.com/microsoft/vcpkg#quick-start-windows) to install the prerequisites:
+
+```
+# dynamic linking 64-bit
+> vcpkg install libftdi1:x64-windows libusb:x64-windows
+> set VCPKGRS_DYNAMIC=1
+
+# static linking 64-bit
+> vcpkg install libftdi1:x64-windows-static-md libusb:x64-windows-static-md
+```
+
+#### macOS
+
+On macOS, [homebrew](https://brew.sh/) is the suggested method to install libftdi:
+
+```
+> brew install libftdi
+```
+
 # Sentry logging
 
 We use Sentry to record crash data. This helps us trace crashes better.

diff --git a/src/main.rs b/src/main.rs
@@ -40,7 +40,7 @@ lazy_static::lazy_static! {
 
 const CARGO_NAME: &'static str = env!("CARGO_PKG_NAME");
 const CARGO_VERSION: &'static str = env!("CARGO_PKG_VERSION");
-const GIT_VERSION: &'static str = git_version::git_version!();
+const GIT_VERSION: &'static str = git_version::git_version!(fallback = "crates.io");
 
 #[derive(Debug, StructOpt)]
 struct Opt {