Updates to README and documentation

Merges: #2

Author: chrysn

.github/workflows/formal.yml

@@ -0,0 +1,31 @@
+name: Formal checks
+
+on:
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  rustfmt:
+    runs-on: ubuntu-latest
+    container: rustlang/rust:nightly
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+    - name: Run cargo-fmt
+      run: cargo fmt --check
+
+  cargo-readme:
+    runs-on: ubuntu-latest
+    container: rustlang/rust:nightly
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+    - uses: actions-rs/[email protected]
+      with:
+        crate: cargo-readme
+        version: latest
+    - name: Verify that README.rst is up to date
+      run: cargo +nightly readme | diff /dev/stdin README.md

.github/workflows/rustfmt.yml

@@ -1,13 +1,12 @@
 [package]
 name = "riot-sys"
 version = "0.7.7"
-authors = ["Christian M. Amsüss <ca@etonomy.org>"]
+authors = ["Christian Amsüss <chrysn@fsfe.org>"]
 edition = "2018"
 
 description = "Rust FFI wrappers for the RIOT operating system"
 documentation = "https://rustdoc.etonomy.org/riot_sys/"
-repository = "https://gitlab.com/etonomy/riot-sys"
-readme = "README.md"
+repository = "https://github.com/RIOT-OS/rust-riot-sys/"
 keywords = ["riot", "riot-os", "iot", "bindings"]
 categories = ["external-ffi-bindings", "no-std"]
 license = "LGPL-2.1"

Cargo.toml

@@ -84,5 +84,5 @@ License
 This crate is licensed under the same terms as of the LGPL-2.1, following the
 license terms of the RIOT Operating System.
 
-It is maintained by Christian M. Amsüss <ca@etonomy.org> as part of the etonomy
-project, see <https://etonomy.org/>.
+It is maintained by Christian Amsüss <chrysn@fsfe.org> as part of the etonomy
+project, see <https://etonomy.org/>, and the RIOT team.

README.md

@@ -10,5 +10,5 @@ License
 This crate is licensed under the same terms as of the {{license}}, following the
 license terms of the RIOT Operating System.
 
-It is maintained by Christian M. Amsüss <ca@etonomy.org> as part of the etonomy
-project, see <https://etonomy.org/>.
+It is maintained by Christian Amsüss <chrysn@fsfe.org> as part of the etonomy
+project, see <https://etonomy.org/>, and the RIOT team.

README.tpl

@@ -61,6 +61,9 @@
 //!
 //! [C2Rust]: https://c2rust.com/
 //!
+//! Usually, the `c2rust` binary is selected through the `PATH` environment variable.
+//! The `C2RUST` environment variable can be used to override this.
+//!
 //! ---
 //!
 //! The types and constants of RIOT are translated in two forms: