|
9 | 9 | //! important UEFI concepts. For more details of UEFI, see the latest [UEFI
|
10 | 10 | //! Specification][spec].
|
11 | 11 | //!
|
12 |
| -//! Feel free to file bug reports and questions in our [issue tracker], and [PR |
13 |
| -//! contributions][contributing] are also welcome! |
| 12 | +//! # About this Document |
| 13 | +//! |
| 14 | +//! In this document, you find general information about this crate, such |
| 15 | +//! as examples and the technical documentation of the public API, as well |
| 16 | +//! as general information about the project, such as license or MSRV |
| 17 | +//! requirements. |
14 | 18 | //!
|
15 | 19 | //! # Interaction with uefi services
|
16 | 20 | //!
|
|
76 | 80 | //! only unfold their potential when you invoke `uefi::helpers::init` as soon
|
77 | 81 | //! as possible in your application.
|
78 | 82 | //!
|
| 83 | +//! # Discuss and Contribute |
| 84 | +//! |
| 85 | +//! For general discussions, feel free to join us in our [Zulip] and ask |
| 86 | +//! your questions there. |
| 87 | +//! |
| 88 | +//! Further, you can submit bugs and also ask questions in our [issue tracker]. |
| 89 | +//! Contributions in form of a PR are also highly welcome. Check our |
| 90 | +//! [contributing guide][contributing] for details. |
| 91 | +//! |
| 92 | +//! # MSRV |
| 93 | +//! <!-- Keep in Sync with README! --> |
| 94 | +//! |
| 95 | +//! The minimum supported Rust version is currently 1.70. |
| 96 | +//! Our policy is to support at least the past two stable releases. |
| 97 | +//! |
| 98 | +//! # License |
| 99 | +//! <!-- Keep in Sync with README! --> |
| 100 | +//! |
| 101 | +//! The code in this repository is licensed under the Mozilla Public License 2. |
| 102 | +//! This license allows you to use the crate in proprietary programs, but any |
| 103 | +//! modifications to the files must be open-sourced. |
| 104 | +//! |
| 105 | +//! The full text of the license is available in the [license file][LICENSE]. |
| 106 | +//! |
79 | 107 | //! # Trivia and Background
|
80 | 108 | //!
|
81 | 109 | //! [UEFI] started as the successor firmware to the BIOS in x86 space and
|
|
89 | 117 | //!
|
90 | 118 | //! [Rust UEFI Book]: https://rust-osdev.github.io/uefi-rs/HEAD/
|
91 | 119 | //! [UEFI]: https://uefi.org/
|
| 120 | +//! [Zulip]: https://rust-osdev.zulipchat.com |
92 | 121 | //! [`BootServices`]: table::boot::BootServices
|
93 | 122 | //! [`GlobalAlloc`]: alloc::alloc::GlobalAlloc
|
94 | 123 | //! [`SystemTable`]: table::SystemTable
|
|
0 commit comments