summaryrefslogtreecommitdiff
path: root/PrmPkg/Readme.md
diff options
context:
space:
mode:
authorMichael Kubacki <michael.kubacki@microsoft.com>2020-06-12 11:34:41 -0700
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>2022-04-05 00:42:38 +0000
commitd10b8dc5d84edf6cad7809e2a3301e713bc79d61 (patch)
treee04200bb1ee452796c64fd050c68f45241bcaaed /PrmPkg/Readme.md
parentfec018624c7e3059cd3e23d5f1bc6006d99fb673 (diff)
downloadedk2-d10b8dc5d84edf6cad7809e2a3301e713bc79d61.zip
edk2-d10b8dc5d84edf6cad7809e2a3301e713bc79d61.tar.gz
edk2-d10b8dc5d84edf6cad7809e2a3301e713bc79d61.tar.bz2
PrmPkg/Samples/Readme.md: Add initial file
Adds a Readme.md file for the Samples to help a user get started building and using the PRM sample modules. Includes a reference to the Samples/Readme.md file in the top-level file to help make the reader aware the file exists. Cc: Andrew Fish <afish@apple.com> Cc: Kang Gao <kang.gao@intel.com> Cc: Michael D Kinney <michael.d.kinney@intel.com> Cc: Michael Kubacki <michael.kubacki@microsoft.com> Cc: Leif Lindholm <leif@nuviainc.com> Cc: Benjamin You <benjamin.you@intel.com> Cc: Liu Yun <yun.y.liu@intel.com> Cc: Ankit Sinha <ankit.sinha@intel.com> Cc: Nate DeSimone <nathaniel.l.desimone@intel.com> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> Acked-by: Michael D Kinney <michael.d.kinney@intel.com> Acked-by: Liming Gao <gaoliming@byosoft.com.cn> Acked-by: Leif Lindholm <quic_llindhol@quicinc.com> Reviewed-by: Ankit Sinha <ankit.sinha@intel.com>
Diffstat (limited to 'PrmPkg/Readme.md')
-rw-r--r--PrmPkg/Readme.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/PrmPkg/Readme.md b/PrmPkg/Readme.md
index 52b44a9..b79cb66 100644
--- a/PrmPkg/Readme.md
+++ b/PrmPkg/Readme.md
@@ -9,7 +9,7 @@ The `PrmPkg` maintained in this branch provides a single cohesive set of generic
to be leveraged by platform firmware with minimal overhead to integrate PRM functionality in the firmware.
## **IMPORTANT NOTE**
-> The code provided in this package and branch are for proof-of-concept purposes only. The code does not represent a
+> The code provided in this package and branch are for proof-of-concept purposes only. The code does not represent a
formal design and is not validated at product quality. The development of this feature is shared in the edk2-staging
branch to simplify collaboration by allowing direct code contributions and early feedback throughout its development.
@@ -120,6 +120,9 @@ prevent the package from being used as-is should be addressed directly in PrmPkg
## PRM Module
+> __*Note*__: You can find simple examples of PRM modules in the Samples directory of this package.
+> [Samples/Readme.md](PrmPkg/Samples/Readme.md) has more information.
+
By default, the EDK II implementation of UEFI does not allow images with the subsystem type
IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER to be built with exports.