From 476f29c4dde17e958dc2d3280acee3a19e87bb47 Mon Sep 17 00:00:00 2001 From: nils-grepit Date: Sun, 15 Sep 2019 22:43:10 +0200 Subject: [PATCH 1/3] add CONTRIBUTING.md and link to Matrix room --- CONTRIBUTING.md | 16 ++++++++++++++++ README.md | 10 ++++++++++ 2 files changed, 26 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..b9d2f49b52 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,16 @@ +# Contributing +## New features +New features should go through the [RFC process][rfcs] before a Pull Request is made to this repository. + +[rfcs](https://github.com/rtfm-rs/rfcs) + +## Bugs +Report bugs by creating an issue in this repository. + +## Pull Requests +Please make pull requests against the master branch. + +Always use rebase instead of merge when bringing in changes from master to your feature branch. + +## Writing documentation +Documentation improvements are always welcome. The source for the book is in `book/` and API documentation is generated from the source code. diff --git a/README.md b/README.md index ff33da9859..75661ec41c 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,16 @@ A concurrency framework for building real time systems. ## [API reference](https://japaric.github.io/rtfm5/api/rtfm/index.html) +## Chat +Join us and talk about RTFM in the [Matrix room][matrix-room]. + +[matrix-room]: https://matrix.to/#/!yafYEipFNsXDdwiHMT:matrix.org + +## Contributing +New features and big changes should go through the RFC process in the [dedicated RFC repository][rfcs]. See [CONTRIBUTING.md](CONTRIBUTING.md) for details. + +[rfcs]: https://github.com/rtfm-rs/rfcs + ## Acknowledgments This crate is based on [the RTFM language][rtfm-lang] created by the Embedded From 7f1b493c7dcda874c88cad6e5f3badd91d8e6989 Mon Sep 17 00:00:00 2001 From: Jorge Aparicio Date: Sun, 15 Sep 2019 22:57:43 +0200 Subject: [PATCH 2/3] turn git deps into crates.io deps --- Cargo.toml | 2 +- macros/Cargo.toml | 4 +--- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 70606c881f..d8b7563e2e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -48,7 +48,7 @@ required-features = ["__v7"] [dependencies] cortex-m = "0.6.0" cortex-m-rtfm-macros = { path = "macros" } -rtfm-core = { git = "https://github.com/rtfm-rs/rtfm-core" } +rtfm-core = "0.3.0-beta.1" cortex-m-rt = "0.6.9" heapless = "0.5.0" diff --git a/macros/Cargo.toml b/macros/Cargo.toml index c7cce5257e..f916818203 100644 --- a/macros/Cargo.toml +++ b/macros/Cargo.toml @@ -18,9 +18,7 @@ proc-macro = true proc-macro2 = "1" quote = "1" syn = "1" - -[dependencies.rtfm-syntax] -git = "https://github.com/rtfm-rs/rtfm-syntax" +rtfm-syntax = "0.4.0-beta.1" [features] heterogeneous = [] From 477a38f13eabcaec0710fe2b83067e66a747f071 Mon Sep 17 00:00:00 2001 From: nils-grepit Date: Sun, 15 Sep 2019 23:04:16 +0200 Subject: [PATCH 3/3] remove reference from README to CONTRIBUTING The book (which includes the text from README.md) does not need to go into that level of detail. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 75661ec41c..a7fb2a57d9 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ Join us and talk about RTFM in the [Matrix room][matrix-room]. [matrix-room]: https://matrix.to/#/!yafYEipFNsXDdwiHMT:matrix.org ## Contributing -New features and big changes should go through the RFC process in the [dedicated RFC repository][rfcs]. See [CONTRIBUTING.md](CONTRIBUTING.md) for details. +New features and big changes should go through the RFC process in the [dedicated RFC repository][rfcs]. [rfcs]: https://github.com/rtfm-rs/rfcs