diff --git a/README.md b/README.md index cb99f10f14a0aa90b7360988d7f5e89586d4ce11..f46b11307009b5b4bd00a558cd81ba39b1651d9a 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,11 @@ -# `cortex-m-quickstart` +# Memory Safety Discussion -> A template for building applications for ARM Cortex-M microcontrollers +First of all, we do use unsafe Rust code. This means that the safety of our static global variables is at risk! +If we do not take action to prevent differet functions from manipulating the variables at the same time, +without some form of mutual exclusive access to the variables, +then they may create undefined behavior and errors. +Because the compiler won't check unsafe code, +this could potentially in a worst case lead to information leakage or perhaps physical damage to infrastructure or people, +all depending on what the code is able to affect. -# [Documentation](https://docs.rs/cortex-m-quickstart) -# License - -Licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - http://www.apache.org/licenses/LICENSE-2.0) - -- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) - -at your option. - -## Contribution - -Unless you explicitly state otherwise, any contribution intentionally submitted -for inclusion in the work by you, as defined in the Apache-2.0 license, shall be -dual licensed as above, without any additional terms or conditions.