From b1ec489860e384bbfc8befd10488d6a43d39458f Mon Sep 17 00:00:00 2001 From: Vivian Nowka-Keane Date: Wed, 27 Mar 2024 13:50:22 -0700 Subject: [PATCH] update readme --- .../Windows/AdvLoggerDumpWin/ReadMe.md | 27 ++++++++++++------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/AdvLoggerPkg/Application/Windows/AdvLoggerDumpWin/ReadMe.md b/AdvLoggerPkg/Application/Windows/AdvLoggerDumpWin/ReadMe.md index ab916944ab..64c819bf1f 100644 --- a/AdvLoggerPkg/Application/Windows/AdvLoggerDumpWin/ReadMe.md +++ b/AdvLoggerPkg/Application/Windows/AdvLoggerDumpWin/ReadMe.md @@ -10,6 +10,24 @@ parses the in-memory UefiLog to a text stream and writes the decoded log to a lo script can be used to both retrieve the log and decode it. AdvLoggerDumpWin is able to be used in systems without Python. +## Building +To build the project, install Visual Studio 2022 with the following workloads: +* Desktop development with C++ +* Universal Windows Platform development + +For individual components, ensure the following are installed (may be included with the above workloads): +* Windows 11 SDK +* NugGet package manager +* MSVC v143 - VS 2022 C++ (Your Architecture) build tools +* C++ ATL fot latest v143 build tools (Your Architecture) +* C++ MFC for latest v143 build tools (Your Architecture) + +In Visual Studio, open the project solution file AdvLoggerPkg\Application\Windows\AdvLoggerDumpWin.sln +The packages.config should tell NuGet to install the Microsoft.Windows.CppWinRT package. If not, add nuget.org +as a package source and install the package. + +Build the solution in Release mode. The executable will be in the Release folder for the given architecture. + ## Usage: With administrator privileges, run the executable. In an administrator command prompt: @@ -18,15 +36,6 @@ AdvLoggerDumpWin.exe ``` The program creates a new log file `new_logfile.bin` in the current directory. - -## Building -To build the project, open the solution file in Visual Studio. -Ensure you have the necessary dependencies. - * Microsoft.Windows.CppWinRT package - * Windows SDK - * VS build tools - - ## Copyright Copyright (C) Microsoft Corporation. All rights reserved. SPDX-License-Identifier: BSD-2-Clause-Patent \ No newline at end of file