Skip to content

Commit f12ad28

Browse files
nicholasbishopphip1611
authored andcommitted
readme: Drop crate feature list
The feature lists are covered in the crate docstrings now, and the crate READMEs link to that source as well. Drop the list here so we don't have to worry about keeping them in sync.
1 parent 16e8f23 commit f12ad28

File tree

1 file changed

+1
-15
lines changed

1 file changed

+1
-15
lines changed

README.md

+1-15
Original file line numberDiff line numberDiff line change
@@ -30,23 +30,9 @@ Check out [the UEFI application template](template) for a quick start.
3030

3131
This project contains multiple sub-crates:
3232

33-
- `uefi` (top directory): defines the standard UEFI tables / interfaces.
33+
- `uefi`: defines the standard UEFI tables / interfaces.
3434
The objective is to stay unopinionated and safely wrap most interfaces.
3535

36-
**Optional crate features:**
37-
38-
- `alloc`: Enables functionality requiring the `alloc` crate from the Rust standard library.
39-
- For example, this allows many convenient `uefi-rs` functions to operate on heap data (`Box`).
40-
- It is up to the user to provide a `#[global_allocator]`.
41-
- `global_allocator`: implements a `#[global_allocator]` using UEFI functions.
42-
- This allows you to use all abstractions from the `alloc` crate from the Rust standard library
43-
during runtime. Hence, `Vec`, `Box`, etc. will be able to allocate memory.
44-
**This is optional**, so you can provide a custom `#[global_allocator]` as well.
45-
- There's no guarantee of the efficiency of UEFI's allocator.
46-
- `logger`: logging implementation for the standard [`log`] crate.
47-
- Prints output to UEFI console.
48-
- No buffering is done: this is not a high-performance logger.
49-
5036
- `uefi-macros`: procedural macros that are used to derive some traits in `uefi`.
5137

5238
- `uefi-services`: provides a panic handler, and initializes the `alloc` / `logger` features.

0 commit comments

Comments
 (0)