From 4da02b2d64c8d9197b690d7644749fd361ccea69 Mon Sep 17 00:00:00 2001 From: Joursoir Date: Sun, 13 Feb 2022 09:09:57 +0300 Subject: readme: update information --- README.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7f98df8..479aa8d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,15 @@ # UEFI File Manager (UFM) -A dual pane file manager with a text based user interface for UEFI environment. Distributed under the BSD-2-Clause Plus Patent License. +A dual pane file manager with a text based user interface for UEFI Shell environment (requires v2.0 or higher). The application is based on the [TianoCore EDK II](https://www.tianocore.org/) development environment. Distributed under the BSD-2-Clause Plus Patent License. + + +## Features: + +* Support all available text-modes on standard output +* Work with devices that support the Simple File System Protocol +* Execute an application +* Use internal `edit` and `hexedit` editors +* Copy, create, move/rename, remove files/directories -_Requires EFI Shell v2.0 and above for correct work_ ## Installation: 1) Move all files from Library to ShellPkg/Library @@ -30,11 +38,13 @@ ShellPkg/Application/Shell/Shell.inf { 2) Add the following lines to ShellPkg/ShellPkg.dsc: **Section LibraryClasses.common:** + ``` UfmCommandLib|ShellPkg/Library/UefiShellUfmCommandLib/UefiShellUfmCommandLib.inf ``` **Section Components:** + ``` ShellPkg/Application/UfmApp/UfmApp.inf ``` @@ -45,6 +55,7 @@ ShellPkg/Application/UfmApp/UfmApp.inf UfmCommandLib|Include/Library/UfmCommandLib.h ``` + ## Usage: ``` @@ -69,8 +80,16 @@ Keyboard Inputs: - F1-F10: special commands ``` + ## Screenshots: ![](ufm-screenshot.png) ![](ufm-screenshot2.png) + + +## Useful resources & documentation: + +[UEFI Shell Specification Version 2.2](https://uefi.org/sites/default/files/resources/UEFI_Shell_2_2.pdf) + +[EDK II Documentation](https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Documentation) -- cgit v1.2.3-18-g5258