Skip to content

Commit 6bfa1d2

Browse files
committed
doc: streamline sections Contributing, MSRV, and License
Copy MSRV, License, and Contributing sections to lib.rs and streamline it with the README equivalents. We should also include these information in lib.rs, as it is the main entry point into everything relevant about the library. At least, it should from now on. The big benefit is that the documentation on `docs.rs` then covers everything relevant.
1 parent d85b4c9 commit 6bfa1d2

File tree

2 files changed

+34
-7
lines changed

2 files changed

+34
-7
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -122,11 +122,14 @@ most of the library's functionality.
122122
Check out the testing project's [`README.md`](uefi-test-runner/README.md) for
123123
prerequisites for running the tests.
124124

125-
## Contributing
125+
## Discuss and Contribute
126126

127-
We welcome issues and pull requests! For instructions on how to set up a
128-
development environment and how to add new protocols, check out
129-
[CONTRIBUTING.md](CONTRIBUTING.md).
127+
For general discussions, feel free to join us in our [Zulip] and ask
128+
your questions there.
129+
130+
Further, you can submit bugs and also ask questions in our [issue tracker].
131+
Contributions in form of a PR are also highly welcome. Check our
132+
[contributing guide](./CONTRIBUTING.md) for details.
130133

131134
## License
132135

@@ -137,3 +140,4 @@ modifications to the files must be open-sourced.
137140
The full text of the license is available in the [license file](LICENSE).
138141

139142
[UEFI]: https://en.wikipedia.org/wiki/Unified_Extensible_Firmware_Interface
143+
[Zulip]: https://rust-osdev.zulipchat.comse)

uefi/src/lib.rs

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@
99
//! important UEFI concepts. For more details of UEFI, see the latest [UEFI
1010
//! Specification][spec].
1111
//!
12-
//! Feel free to file bug reports and questions in our [issue tracker], and [PR
13-
//! contributions][contributing] are also welcome!
14-
//!
1512
//! # About this Document
1613
//!
1714
//! In this document, you find general information about this crate, such
@@ -83,6 +80,30 @@
8380
//! only unfold their potential when you invoke `uefi::helpers::init` as soon
8481
//! as possible in your application.
8582
//!
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+
//!
86107
//! # Trivia and Background
87108
//!
88109
//! [UEFI] started as the successor firmware to the BIOS in x86 space and
@@ -94,8 +115,10 @@
94115
//! form of additional drivers, OS-specific bootloaders, or any different kind
95116
//! of low-level applications (such as an [IRC client][uefirc]).
96117
//!
118+
//! [LICENSE]: https://github.com/rust-osdev/uefi-rs/blob/main/uefi/LICENSE
97119
//! [Rust UEFI Book]: https://rust-osdev.github.io/uefi-rs/HEAD/
98120
//! [UEFI]: https://uefi.org/
121+
//! [Zulip]: https://rust-osdev.zulipchat.com
99122
//! [`BootServices`]: table::boot::BootServices
100123
//! [`GlobalAlloc`]: alloc::alloc::GlobalAlloc
101124
//! [`SystemTable`]: table::SystemTable

0 commit comments

Comments
 (0)