Refactor Windows documentation #12013

Tamir91 · 2023-07-18T14:19:06Z

Tracked on [LRS-832].

1. A title was changed. 2. A Cmake screenshot was changed. 2. Block with Windows 8.1 removed.

Nir-Az · 2023-07-19T06:16:08Z

doc/installation_windows.md


 **Note:** Due to the USB 3.0 translation layer between native hardware and virtual machine, the librealsense team does not recommend or support installation in a VM.

-librealsense shall be built on Windows using [CMake v3.8+](https://cmake.org/download/) and Visual Studio 2015 / 2017: 
+librealsense shall be built on Windows using [CMake v3.8+](https://cmake.org/download/) and Visual Studio 2015 / 2017 / 2019: 


2022 as well

Please verify the minimum cmake version , I dont think it's 3.8 today

Please verify the minimum cmake version , I dont think it's 3.8 today

I scanned entire repo and found that a lowest CMake version is 2.8.3. (third party dependency)
So I need write 2.8.3 in the guide?

Which 3-rd party? seems too low.

C:\Users\tyurovs\repos\librealsense\src\gl\CMakeLists.txt (1 hit)
Line 4: cmake_minimum_required(VERSION 2.8.9...3.20.5)
C:\Users\tyurovs\repos\librealsense\third-party\libusb\CMakeLists.txt (1 hit)
Line 4: cmake_minimum_required(VERSION 2.8.3)
C:\Users\tyurovs\repos\librealsense\third-party\realsense-file\CMakeLists.txt (1 hit)
Line 1: cmake_minimum_required(VERSION 2.8.9...3.20.5)
C:\Users\tyurovs\repos\librealsense\tools\rosbag-inspector\CMakeLists.txt (1 hit)
Line 4: cmake_minimum_required(VERSION 2.8.3...3.20.5)

C:\Users\tyurovs\repos\librealsense\third-party\realsense-file\rosbag\config.cmake (1 hit)
Line 1: cmake_minimum_required(VERSION 2.8...3.20.5)
C:\Users\tyurovs\repos\librealsense\third-party\realsense-file\rosbag\console_bridge\config.cmake (1 hit)
Line 1: cmake_minimum_required(VERSION 2.8...3.20.5)
C:\Users\tyurovs\repos\librealsense\third-party\realsense-file\rosbag\cpp_common\config.cmake (1 hit)
Line 1: cmake_minimum_required(VERSION 2.8.3...3.20.5)
C:\Users\tyurovs\repos\librealsense\third-party\realsense-file\rosbag\rosbag_storage\config.cmake (1 hit)
Line 1: cmake_minimum_required(VERSION 2.8.3...3.20.5)
C:\Users\tyurovs\repos\librealsense\third-party\realsense-file\rosbag\roscpp_serialization\config.cmake (1 hit)
Line 1: cmake_minimum_required(VERSION 2.8.3...3.20.5)
C:\Users\tyurovs\repos\librealsense\third-party\realsense-file\rosbag\roscpp_traits\config.cmake (1 hit)
Line 1: cmake_minimum_required(VERSION 2.8.3...3.20.5)
C:\Users\tyurovs\repos\librealsense\third-party\realsense-file\rosbag\roslz4\config.cmake (1 hit)
Line 1: cmake_minimum_required(VERSION 2.8.3...3.20.5)
C:\Users\tyurovs\repos\librealsense\third-party\realsense-file\rosbag\rostime\config.cmake (1 hit)
Line 1: cmake_minimum_required(VERSION 2.8.3...3.20.5)

Make sure someone use those cmake files, I bet not.

Nir-Az · 2023-07-19T06:20:59Z

doc/installation_windows.md


-## Windows 8.1:
-When working on Windows 8.1, make sure you have [KB3075872](https://support.microsoft.com/en-us/kb/3075872) and [KB2919355](https://support.microsoft.com/en-us/kb/2919355) installed. These patches are addressing issues specific to 8.1 video drivers, that were later resolved in Windows 10.
+Don't forget to check `BUILD_EXAMPLES` if you wish to use librealsense samples.


Down in the document please update according to this:
Windows 10 (Build 15063 or later, 17763+ recommended) and Windows 11
The winver image needs to change too

Windows 10 SDK version 1809 | 10.0.17763.0 is being validated by RS.
Lets write only this
Windows 10 (Build 15063 or later, 17763+ recommended) and Windows 11

Instead of both and give this screenshot

Thanks

A build number and screenshot updated.

mengyui · 2023-07-19T07:29:54Z

one more thing, please check the option"Allow desktop apps to access your camera" should be turned on in Setting -> Privacy -> Camera for Windows.
the default value is on.

Nir-Az · 2023-07-25T07:44:26Z

doc/installation_windows.md

@@ -92,3 +87,5 @@ When set, the compiler will check the target WinSDK version, and abort the build

 **Note** In case of multiple WinSDK version installed, CMake automatically selects the latest version of SDK. In some cases, however, the automatic selection may fail. Then you need to manually retarget the solution for the proper WinSDK version: 
 ![win_retarget_platform](./img/win_retarget_platform.png)
+
+**Note** Turn on "Allow desktop apps to access your camera" in Windows OS (Setting -> Privacy -> Camera).


If the camera is not recognized by the SDK, make sure that "Allow desktop apps to access your camera" setting is set to on in Windows OS (Setting -> Privacy -> Camera)

Tamir91 · 2023-07-25T14:35:07Z

The WinSDK is 10 (10.0.15063) according:
https://www.intel.com/content/www/us/en/support/articles/000028594/emerging-technologies/intel-realsense-technology.html

Nir-Az · 2023-07-25T15:13:05Z

The WinSDK is 10 (10.0.15063) according: https://www.intel.com/content/www/us/en/support/articles/000028594/emerging-technologies/intel-realsense-technology.html

This was wriiten at May/2018.
We beed to gound out the current minimak WinSDK

winver png updated issue table created windows build number updated

Nir-Az · 2023-07-31T14:35:48Z

doc/installation_windows.md


 **Note:** Due to the USB 3.0 translation layer between native hardware and virtual machine, the librealsense team does not recommend or support installation in a VM.

-librealsense shall be built on Windows using [CMake v3.8+](https://cmake.org/download/) and Visual Studio 2015 / 2017: 
+librealsense shall be built on Windows using [CMake v3.8+](https://cmake.org/download/) and Visual Studio 2015 / 2017 / 2019 / 2022: 


Please remove 2015

Also we know Cmake 3.8 is not supported, we need to make sure which one is supported and list it

Also we know Cmake 3.8 is not supported, we need to make sure which one is supported and list it

According the test that we performed CMake 3.14 is minimal supported version.
Are you think we need perform other test to validate it? Maybe, install CMake 3.13 locally and build?

Tamir91 · 2023-08-29T07:40:37Z

Added GHA test #12118 that checks minimal CMake supporting version on Linux.

Nir-Az · 2023-08-29T19:42:14Z

@maloel can you help review + spell check?

doc/installation_windows.md

maloel · 2023-09-04T11:47:56Z

Looks good from my side

Small changes

b87bea6

1. A title was changed. 2. A Cmake screenshot was changed. 2. Block with Windows 8.1 removed.

Nir-Az reviewed Jul 19, 2023

View reviewed changes

Note added

3e67c2b

Nir-Az reviewed Jul 25, 2023

View reviewed changes

Note refactored

1923071

small updates

32f5255

winver png updated issue table created windows build number updated

Nir-Az reviewed Jul 31, 2023

View reviewed changes

CMake and Visual Studio versions updated

7c5e356

Tamir91 requested a review from Nir-Az August 9, 2023 08:19

Nir-Az requested a review from maloel August 29, 2023 19:41

maloel reviewed Aug 30, 2023

View reviewed changes

doc/installation_windows.md Outdated Show resolved Hide resolved

maloel reviewed Aug 30, 2023

View reviewed changes

doc/installation_windows.md Outdated Show resolved Hide resolved

typo fixed

3b3f24f

Tamir91 requested a review from maloel August 30, 2023 05:49

MSVC2015 updated

dce9942

maloel approved these changes Sep 4, 2023

View reviewed changes

Nir-Az merged commit de02cbb into IntelRealSense:development Sep 10, 2023
15 of 16 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor Windows documentation #12013

Refactor Windows documentation #12013

Tamir91 commented Jul 18, 2023

Nir-Az Jul 19, 2023

Nir-Az Jul 19, 2023

Tamir91 Jul 19, 2023

Nir-Az Jul 19, 2023

Tamir91 Jul 19, 2023 •

edited

Loading

Nir-Az Jul 19, 2023

Nir-Az Jul 19, 2023

Nir-Az Jul 27, 2023

Tamir91 Jul 31, 2023

mengyui commented Jul 19, 2023

Nir-Az Jul 25, 2023

Tamir91 Jul 25, 2023

Tamir91 commented Jul 25, 2023 •

edited

Loading

Nir-Az commented Jul 25, 2023

Nir-Az Jul 31, 2023

Nir-Az Jul 31, 2023

Tamir91 Aug 1, 2023

Tamir91 commented Aug 29, 2023

Nir-Az commented Aug 29, 2023

maloel commented Sep 4, 2023

Refactor Windows documentation #12013

Refactor Windows documentation #12013

Conversation

Tamir91 commented Jul 18, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tamir91 Jul 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mengyui commented Jul 19, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tamir91 commented Jul 25, 2023 • edited Loading

Nir-Az commented Jul 25, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tamir91 commented Aug 29, 2023

Nir-Az commented Aug 29, 2023

maloel commented Sep 4, 2023

Tamir91 Jul 19, 2023 •

edited

Loading

Tamir91 commented Jul 25, 2023 •

edited

Loading