Add a Readme.rst file to explain what this package is for, link to
additional information etc.

Signed-off-by: Rebecca Cran <rebecca@bsdio.com>
---
 Platform/BeagleBoard/BeagleBoardPkg/Readme.rst | 28 ++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/Platform/BeagleBoard/BeagleBoardPkg/Readme.rst b/Platform/BeagleBoard/BeagleBoardPkg/Readme.rst
new file mode 100644
index 000000000000..b97eb02eea66
--- /dev/null
+++ b/Platform/BeagleBoard/BeagleBoardPkg/Readme.rst
@@ -0,0 +1,28 @@
+==============
+BeagleBoardPkg
+==============
+
+This package provides support for the original OMAP3530-based BeagleBoard
+(https://beagleboard.org/beagleboard).
+
+Resources
+---------
+
+- BeagleBoard.org Support Page: https://elinux.org/Beagleboard:Main_Page#BeagleBoard
+- BeagleBoard Main Page: https://elinux.org/Beagleboard:BeagleBoard
+- BeagleBoard Community Page: https://elinux.org/BeagleBoard_Community
+- System Reference Manual: https://github.com/beagleboard/BeagleBoard/blob/master/BeagleBoard_revC5_SRM.pdf
+- OMAP35x Technical Reference Manual: https://www.ti.com/lit/ug/spruf98y/spruf98y.pdf
+- Schematics, BOM etc.: https://github.com/beagleboard/beagleboard
+
+Running
+-------
+
+Since the BeagleBoard only has 64KB SRAM and the ROM bootloader can load
+a maximum 128KB file, we use the `MLO` loader to load EDK2.
+BEAGLEBOARD_EFI.fd must be renamed to `u-boot.bin`.
+
+The programs in the Tools directory are for adding the Configuration Header
+that's needed for code to run via the ROM bootloader. They're kept for reference
+and are unused.
+
-- 
2.31.1




-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#81232): https://edk2.groups.io/g/devel/message/81232
Mute This Topic: https://groups.io/mt/85933041/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-