[doc] Update the cmake build documentation for linux

Signed-off-by: Douglas Reis <[email protected]>
microsoft · Jan 31, 2025 · 634474d · 634474d
1 parent ce4df74
commit 634474d
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 3 deletions.
diff --git a/docs/BuildSystems/Build.CMake.md b/docs/BuildSystems/Build.CMake.md
@@ -182,3 +182,22 @@ cmake --build DebugOpenSSL32
 
 If everything went well, you should have a working Simulator.exe in:
 `TPMCmd\DebugOpenSSL32\install\bin\Simulator.exe`
+
+## Linux + OpenSSL using command-line cmake
+
+1. Install cmake, gcc and openssl using the linux distribution package manager.
+2. Setup the CMake build environment
+```
+cmake -S TPMCmd/. -B TPMCmd/build/.
+```
+This tells CMake to set the top level of the Source tree to TPMCmd/ and create a Build
+directory "TPMCmd/build/"
+
+4. Execute the build
+Instruct CMake to build the build environment just created.
+```
+cmake --build TPMCmd/build/.
+```
+
+If everything went well, you should have a working binary in:
+`TPMCmd\build\Simulator`
diff --git a/docs/BuildSystems/BuildIntro.md b/docs/BuildSystems/BuildIntro.md
@@ -35,14 +35,13 @@ subject to the [Contributing Guidelines](../../CONTRIBUTING.md)
 | AutoTools          | Linux            | YES, Deprecation planned |
 | AutoTools          | MacOsX           | NO                       |
 | CMake              | Windows          | YES                      |
-| CMake              | Linux            | NO, Future plan          |
+| CMake              | Linux            | YES                      |
 | Visual Studio 2017 | Windows          | YES, Deprecation planned |
 | Visual Studio 2022 | Windows          | NO, Future plan          |
 
 ## Future Work
 
-As implied by the table above, CMake is expected to replace AutoTools support,
-and VS2022 will replace VS2017.
+As implied by the table above VS2022 will replace VS2017.
 
 ## Code Layout