Skip to content

Commit c6f4859

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 d2fe713 commit c6f4859

File tree

2 files changed

+34
-4
lines changed

2 files changed

+34
-4
lines changed

README.md

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

119-
## Contributing
119+
## Discuss and Contribute
120120

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

125128
## License
126129

@@ -131,3 +134,4 @@ modifications to the files must be open-sourced.
131134
The full text of the license is available in the [license file](LICENSE).
132135

133136
[UEFI]: https://en.wikipedia.org/wiki/Unified_Extensible_Firmware_Interface
137+
[Zulip]: https://rust-osdev.zulipchat.com

uefi/src/lib.rs

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,30 @@
103103
//! only unfold their potential when you invoke `uefi::helpers::init` as soon
104104
//! as possible in your application.
105105
//!
106+
//! # Discuss and Contribute
107+
//!
108+
//! For general discussions, feel free to join us in our [Zulip] and ask
109+
//! your questions there.
110+
//!
111+
//! Further, you can submit bugs and also ask questions in our [issue tracker].
112+
//! Contributions in form of a PR are also highly welcome. Check our
113+
//! [contributing guide][contributing] for details.
114+
//!
115+
//! # MSRV
116+
//! <!-- Keep in Sync with README! -->
117+
//!
118+
//! The minimum supported Rust version is currently 1.70.
119+
//! Our policy is to support at least the past two stable releases.
120+
//!
121+
//! # License
122+
//! <!-- Keep in Sync with README! -->
123+
//!
124+
//! The code in this repository is licensed under the Mozilla Public License 2.
125+
//! This license allows you to use the crate in proprietary programs, but any
126+
//! modifications to the files must be open-sourced.
127+
//!
128+
//! The full text of the license is available in the [license file][LICENSE].
129+
//!
106130
//! # Trivia and Background
107131
//!
108132
//! [UEFI] started as the successor firmware to the BIOS in x86 space and
@@ -117,8 +141,10 @@
117141
//! Even joke projects such as an [IRC client][uefirc] leveraging only existing
118142
//! UEFI boot services are possible! 😉
119143
//!
144+
//! [LICENSE]: https://github.com/rust-osdev/uefi-rs/blob/main/uefi/LICENSE
120145
//! [Rust UEFI Book]: https://rust-osdev.github.io/uefi-rs/HEAD/
121146
//! [UEFI]: https://uefi.org/
147+
//! [Zulip]: https://rust-osdev.zulipchat.com
122148
//! [`BootServices`]: table::boot::BootServices
123149
//! [`GlobalAlloc`]: alloc::alloc::GlobalAlloc
124150
//! [`SystemTable`]: table::SystemTable

0 commit comments

Comments
 (0)