Skip to content

Commit 048ffa1

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 876a2cc commit 048ffa1

File tree

2 files changed

+34
-7
lines changed

2 files changed

+34
-7
lines changed

README.md

+8-4
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 the 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

+26-3
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@
77
//! important UEFI concepts. For more details of UEFI, see the latest [UEFI
88
//! Specification][spec].
99
//!
10-
//! Feel free to file bug reports and questions in our [issue tracker], and [PR
11-
//! contributions][contributing] are also welcome!
12-
//!
1310
//! # Interaction with uefi services
1411
//!
1512
//! With this crate you can write code for the pre- and post-exit boot services
@@ -80,8 +77,34 @@
8077
//! only unfold their potential when you invoke `uefi::helpers::init` as soon
8178
//! as possible in your application.
8279
//!
80+
//! # Discuss and Contribute
81+
//!
82+
//! For general discussions, feel free to join us in our [Zulip] and ask
83+
//! your questions there.
84+
//!
85+
//! Further, you can submit bugs and also ask questions in our [issue tracker].
86+
//! Contributions in the form of a PR are also highly welcome. Check our
87+
//! [contributing guide][contributing] for details.
88+
//!
89+
//! # MSRV
90+
//! <!-- Keep in Sync with README! -->
91+
//!
92+
//! The minimum supported Rust version is currently 1.70.
93+
//! Our policy is to support at least the past two stable releases.
94+
//!
95+
//! # License
96+
//! <!-- Keep in Sync with README! -->
97+
//!
98+
//! The code in this repository is licensed under the Mozilla Public License 2.
99+
//! This license allows you to use the crate in proprietary programs, but any
100+
//! modifications to the files must be open-sourced.
101+
//!
102+
//! The full text of the license is available in the [license file][LICENSE].
103+
//!
104+
//! [LICENSE]: https://github.com/rust-osdev/uefi-rs/blob/main/uefi/LICENSE
83105
//! [Rust UEFI Book]: https://rust-osdev.github.io/uefi-rs/HEAD/
84106
//! [UEFI]: https://uefi.org/
107+
//! [Zulip]: https://rust-osdev.zulipchat.com
85108
//! [`BootServices`]: table::boot::BootServices
86109
//! [`GlobalAlloc`]: alloc::alloc::GlobalAlloc
87110
//! [`SystemTable`]: table::SystemTable

0 commit comments

Comments
 (0)