Commit Graph

43 Commits

Author SHA1 Message Date
Dario Nieuwenhuis
bf488dfb20 docs: update readmes for v1.0 2024-01-09 21:35:40 +01:00
Yuri Astrakhan
f3095b3d01 A few minor spelling/grammar fixes 2023-09-01 01:30:51 -04:00
Dario Nieuwenhuis
ebde206150 readme: add io crates. 2023-07-17 12:27:58 +02:00
Dario Nieuwenhuis
7d975f025d Bump MSRV to 1.60
Needed for namespaced features (`dep:` in Cargo.toml)
2023-07-15 16:04:24 +02:00
Dario Nieuwenhuis
d36ddc2009 Bump MSRV to 1.59, switch to Edition 2021. 2023-02-28 21:09:10 +01:00
Diego Barrios Romero
db47d29558 Prepare e-h 1.0.0-alpha.9 release 2022-09-28 20:53:37 +02:00
kraktus
d2512efecd Fix README link 2022-09-28 14:11:47 +02:00
Dario Nieuwenhuis
bc3fc45bb9 Reorganize READMEs
- Move "project-wide" stuff (CoC, legal boilerplate) to the main README.
- List crates in main README.
2022-09-26 13:29:34 +02:00
Dario Nieuwenhuis
6d22f986f1 Move embedded-hal to a subdir, add workspace, simplify CI. 2022-09-26 13:29:34 +02:00
Diego Barrios Romero
0a3a858069 Prepare 1.0.0-alpha.8 release 2022-04-14 21:56:21 +02:00
bors[bot]
178f66ba07 Merge #368
368: Document MSRV upgrade and improve readme r=ryankurte a=eldruin

I moved some of the sections in the README out into separate documents in a `docs` folder.
I have left the section about alpha releases in there, though. I think it is important enough to grant it its placement.
I have added a document describing a policy to upgrade the MSRV, since this will eventually be important once we have released the `1.0.0` version.

TL;DR: The MSRV may be updated in major or minor releases but not on patch releases.

Closes #364 


Co-authored-by: Diego Barrios Romero <eldruin@gmail.com>
2022-02-24 22:10:28 +00:00
Diego Barrios Romero
b6bebf2ec6 Document how the MSRV may be upgraded 2022-02-22 21:53:12 +01:00
Diego Barrios Romero
f3324dc17b Improve implementations and drivers section 2022-02-22 21:50:59 +01:00
Diego Barrios Romero
a5394bf42d Move version policy into separate document 2022-02-22 21:50:09 +01:00
Diego Barrios Romero
8446a116e9 Move new trait how-to into separate document 2022-02-22 21:47:19 +01:00
Dario Nieuwenhuis
01e6b68c9c SPI: split into device/bus, allows sharing buses with automatic CS management.
Co-authored-by: Diego Barrios Romero <eldruin@gmail.com>
2022-02-18 02:33:22 +01:00
bors[bot]
f3c502acdd Merge #325
325: Update readme notes on alpha / 0.2.x compatibility r=eldruin a=ryankurte

i wasn't sure whether to remove the comment about implementing both completely as it seems superfluous given the availability of a `compat` layer?

cc. `@eldruin`

Co-authored-by: ryan kurte <ryankurte@gmail.com>
2021-11-14 11:35:21 +00:00
ryan kurte
056654254f Update docs about alpha / 0.2.x compatibility 2021-11-14 11:20:00 +13:00
Timo Kröger
738732369a Raise MSRV to Rust 1.46.0 2021-10-26 14:20:20 +02:00
Diego Barrios Romero
c2ceb78540 Raise MSRV to Rust 1.40.0 2021-10-04 11:19:38 +02:00
Diego Barrios Romero
43a8c69f2c Add scope to readme 2021-07-07 08:59:08 +02:00
Diego Barrios Romero
d2e96ce6c8 Add MSRV badge 2021-07-06 13:31:58 +02:00
Andrey Zgarbul
314c1f02ca badges 2021-07-05 18:44:22 +03:00
Diego Barrios Romero
9f0e938f29 Fix link + wording
Co-authored-by: Hanno Braun <hanno@braun-odw.eu>
2021-04-29 14:47:28 +02:00
Diego Barrios Romero
4cb3976f34 Add documentation on how to support an alpha version side-by-side with a 0.2.x version 2021-04-29 08:48:13 +02:00
Diego Barrios Romero
713231739c Clarify usage of alpha releases 2020-10-30 09:39:04 +01:00
bors[bot]
cad3b0c190 Merge #198
198: Add MSRV configuration to CI r=therealprof a=eldruin

The compatibility with the MSRV should be checked by the CI. At the moment that is Rust 1.35.0 due to [this issue](https://github.com/rust-lang/rust/issues/54973).
The MSRV and its update process should probably also be documented in the README.

Co-authored-by: Diego Barrios Romero <eldruin@gmail.com>
2020-04-13 10:38:25 +00:00
Diego Barrios Romero
c61e421d9f Add note about MSRV on README 2020-04-08 09:11:18 +02:00
Ryan
d6a9166dae Update README.md
Co-Authored-By: Daniel Egger <daniel@eggers-club.de>
2020-04-08 09:47:40 +12:00
ryan
74e70253d4 Updated readme with new process 2020-04-05 10:34:27 +12:00
Jorge Aparicio
50de84dd8b README: mention the CoC and who maintains this repo 2018-08-07 00:32:10 -05:00
Jorge Aparicio
dafe3b4f17 remove list of implementations and driver crates from the README ...
in favor of the [awesome-embedded-rust] list

[awesome-embedded-rust]: https://github.com/rust-embedded/awesome-embedded-rust
2018-04-01 23:56:14 +02:00
Daniel Egger
65319b25f4 Added my new NXP MKW41Z based crates to the list 2018-03-20 23:24:08 +01:00
Danilo Bargen
9ba964108a Add MCP3425 ADC driver to README 2018-03-11 03:16:56 +01:00
Daniel Egger
53cf9ab690 Added reference to stm32f042-hal crate 2018-03-04 22:28:19 +01:00
Daniel Egger
4b6b9ce81b Swapped links for my own crates from GH to crates.io 2018-02-25 02:45:04 +01:00
Jorge Aparicio
dd5023667c fix link to the stm32f103xx-hal crate 2018-02-18 01:41:03 +01:00
Jorge Aparicio
bfa0786c8d incorporate feedback 2018-02-16 00:09:09 +01:00
Jorge Aparicio
acead81147 establish a process for adding new traits 2018-02-14 22:55:09 +01:00
Jorge Aparicio
9299c04ce7 tweak crate description 2018-01-20 12:22:44 +01:00
Jorge Aparicio
5295697669 rename to embedded-hal 2017-06-10 19:56:29 -05:00
Jorge Aparicio
b12039609c fix Documentation link 2017-06-09 16:10:52 -05:00
Jorge Aparicio
48464884a9 initial commit 2017-06-09 15:57:32 -05:00