srenblad/rust-fatfs
1
0
Fork 0
forked from M-Labs/rust-fatfs
Code Pull Requests Activity

Update no_std usage in README file

Browse Source
This commit is contained in:
Rafał Harabień 2019-07-17 19:54:27 +02:00
parent 240fd01a9d
commit 59ef23ec98
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -56,12 +56,18 @@ Add this to your `Cargo.toml`:
[dependencies]
fatfs = { version = "0.3", features = ["core_io"], default-features = false }
Note: LFN support requires `alloc` and `core_io/collections` features and makes use of `alloc` crate.
You may have to provide a memory allocator implementation.
For building in `no_std` mode a Rust compiler version compatible with `core_io` crate is required.
For building in `no_std` mode a nightly Rust compiler version compatible with the current `core_io` crate is required.
See a date string in the `core_io` dependency version.
For now `core_io` supports only nightly Rust channel. See a date suffix in latest `core_io` crate version for exact
compiler version.
Additional features:
* `alloc` - use `alloc` crate for dynamic allocation. Required for LFN (long file name) support and API which uses
`String` type. You may have to provide a memory allocator implementation.
Note: above feature is enabled by default.
License
-------
The MIT license. See LICENSE.txt.
The MIT license. See `LICENSE.txt`.