Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
VivianNK committed Mar 27, 2024
1 parent 2187fa4 commit b1ec489
Showing 1 changed file with 18 additions and 9 deletions.
27 changes: 18 additions & 9 deletions AdvLoggerPkg/Application/Windows/AdvLoggerDumpWin/ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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

0 comments on commit b1ec489

Please sign in to comment.