aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJoursoir <chat@joursoir.net>2021-12-02 21:12:48 +0300
committerJoursoir <chat@joursoir.net>2021-12-02 21:12:48 +0300
commit8a1e302685452f531e028dbb05b6bd2ebb7cb7fa (patch)
tree3e7ac09a86107493ff8a55871b48a9723b69d74b /README.md
parent62424fc6411b5e2f9a5224837af4740956f7f5e5 (diff)
downloadufm-8a1e302685452f531e028dbb05b6bd2ebb7cb7fa.tar.gz
ufm-8a1e302685452f531e028dbb05b6bd2ebb7cb7fa.tar.bz2
ufm-8a1e302685452f531e028dbb05b6bd2ebb7cb7fa.zip
readme: write about installation
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 40 insertions, 1 deletions
diff --git a/README.md b/README.md
index 0e3273d..0c27c38 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,46 @@ A dual pane file manager with a text based user interface for UEFI environment.
_Requires EFI Shell v2.0 and above for correct work_
## Installation:
-TODO
+1) Move all files from Library to ShellPkg/Library
+
+2) Add the following line to ShellPkg/ShellPkg.dsc, **section "Components"**:
+
+```
+ShellPkg/Library/UefiShellUfmCommandLib/UefiShellUfmCommandLib.inf
+```
+
+### If you want to integrate UFM in Shell:
+1) Add the following line to ShellPkg/ShellPkg.dsc, **section "LibraryClasses"**, in build of any version of the shell:
+
+```
+ShellPkg/Application/Shell/Shell.inf {
+ ...
+ <LibraryClasses>
+ ...
+ NULL|ShellPkg/Library/UefiShellUfmCommandLib/UefiShellUfmCommandLib.inf # <- add this line
+}
+```
+
+### If you want standalone application:
+1) Move all files from Application, Include to ShellPkg/Application and ShellPkg/Include
+
+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
+```
+
+3) Add the following line to ShellPkg/ShellPkg.dec, **section "LibraryClasses"**:
+
+```
+UfmCommandLib|Include/Library/UfmCommandLib.h
+```
## Organization of code: