diff options
| -rw-r--r-- | CONTRIBUTING.md | 16 | ||||
| -rw-r--r-- | README.md | 10 | ||||
| -rw-r--r-- | book/en/src/preface.md | 2 | ||||
| -rw-r--r-- | src/lib.rs | 2 |
4 files changed, 28 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..b9d2f49b --- /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. @@ -47,6 +47,16 @@ A concurrency framework for building real time systems. ## [API reference](https://rtfm.rs/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]. + +[rfcs]: https://github.com/rtfm-rs/rfcs + ## Acknowledgments This crate is based on [the RTFM language][rtfm-lang] created by the Embedded diff --git a/book/en/src/preface.md b/book/en/src/preface.md index 1728062b..4b537065 100644 --- a/book/en/src/preface.md +++ b/book/en/src/preface.md @@ -5,7 +5,7 @@ # Preface This book contains user level documentation for the Real Time For the Masses -(RTFM) framework. The API reference can be found [here](../api/rtfm/index.html). +(RTFM) framework. The API reference can be found [here](../../api/rtfm/index.html). There is a translation of this book in [Russian]. @@ -10,7 +10,7 @@ //! //! The user level documentation can be found [here]. //! -//! [here]: https://japaric.github.io/rtfm5/book/en/ +//! [here]: https://rtfm.rs //! //! Don't forget to check the documentation of the `#[app]` attribute (listed under the reexports //! section), which is the main component of the framework. |