From 8a1e302685452f531e028dbb05b6bd2ebb7cb7fa Mon Sep 17 00:00:00 2001
From: Joursoir <chat@joursoir.net>
Date: Thu, 2 Dec 2021 21:12:48 +0300
Subject: readme: write about installation

---
 README.md | 41 ++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 40 insertions(+), 1 deletion(-)

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:
 
-- 
cgit v1.2.3-18-g5258