Skip to content

Commit 9cb792e

Browse files
bors[bot]japaric
andcommitted
Merge #108
108: README: update the documentation link r=therealprof a=japaric because we have `readme = "README.md"` set in Cargo.toml the crates.io page renders the README which contains a BIG "Documentation" link that points to docs.rs which is broken. This commit makes that link point to our GH page. r? @rust-embedded/cortex-m (anyone) I have also observed that the smaller "documentation" link in the crates.io page is ignoring the "documentation" field and pointing to docs.rs. I reported this as a bug in rust-lang/crates.io#1485 Co-authored-by: Jorge Aparicio <[email protected]>
2 parents 66a90cd + 33ebd5d commit 9cb792e

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

cortex-m-rt/Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ keywords = ["arm", "cortex-m", "runtime", "startup"]
77
license = "MIT OR Apache-2.0"
88
name = "cortex-m-rt"
99
readme = "README.md"
10-
repository = "https://github.com/japaric/cortex-m-rt"
10+
repository = "https://github.com/rust-embedded/cortex-m-rt"
1111
version = "0.6.1"
1212

1313
[dependencies]

cortex-m-rt/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33

44
# `cortex-m-rt`
55

6-
> Minimal runtime / startup for Cortex-M microcontrollers
6+
> Startup code and minimal runtime for Cortex-M microcontrollers
77
88
This project is developed and maintained by the [Cortex-M team][team].
99

10-
# [Documentation](https://docs.rs/cortex-m-rt)
10+
# [Documentation](https://rust-embedded.github.io/cortex-m-rt)
1111

1212
# License
1313

cortex-m-rt/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Minimal startup / runtime for Cortex-M microcontrollers
1+
//! Startup code and minimal runtime for Cortex-M microcontrollers
22
//!
33
//! This crate contains all the required parts to build a `no_std` application (binary crate) that
44
//! targets a Cortex-M microcontroller.

0 commit comments

Comments
 (0)