For Windows with WSL2 Users Only - Automation Scripts

[gitwjr]

Automation scripts and instruction guides required to build WAVE Test Suite 4.0.0 on Windows with WSL2 platforms. To be posted on dpctf-deploy readme.

[gitwjr]

1_Device_Test.md
2_Device_Test.md
Analyse_Recording_Instructions.md
analyse_wave_recordings.sh
build_wave_wsl.sh
Clean uninstall_Install of required packages.md
WAVE Test Work Flow.md
WAVE WSL Build Repository Layout.md
WAVE_WSL_QuickStart_Guide.md
WAVE_WSL_QuickStart_Guide.pdf
WAVE_WSL_User_Guide.md
WAVE_WSL_User_Guide.pdf

Requires text to user to be added to the dpctf-deploy readme as well.

[louaybassbouss]

1_Device_Test.md 2_Device_Test.md Analyse_Recording_Instructions.md analyse_wave_recordings.sh build_wave_wsl.sh Clean uninstall_Install of required packages.md WAVE Test Work Flow.md WAVE WSL Build Repository Layout.md WAVE_WSL_QuickStart_Guide.md WAVE_WSL_QuickStart_Guide.pdf WAVE_WSL_User_Guide.md WAVE_WSL_User_Guide.pdf

Requires text to user to be added to the dpctf-deploy readme as well.

@gitwjr Which markdown is the entry point for the documentation. Maybe the main Markdown should be README.md in a subfolder called wsl2 or similar.

[gitwjr]

Either the QuickStart Guide or the WAVE_WSL_User_Guide can be the starting point. However, I notice neither reference the other. I suggest I modify the QuickStart Guide to refer to the WAVE_WSL_User_Guide.md noting the difference between them. i.e. add to QuickStart "If you encounter problems during the install, or are not familiar with Linux on Windows with WSL platforms you can find more detailed instructions at [links to WAVE_WSL_User_Guide.md and the PDF version].
With that change the QuickStart Guide would be the main destination.

If you agree I will update the QuickStart Guide and send it to you to replace the original. There should be a clear note in the main README directing users of WSL platforms to the QuickGuide.

Important: The guides are written expecting the Test Suite Scripts folder is included in the initial repo clone: git clone: https://github.com/cta-wave/dpctf-deploy.git ~/dpctf-temp. The scripts are written expecting to find everything in Test Suite Scripts folder. Both guides will direct the user to copy the Test Suite Scripts folder to the Users folder on their machine after they do the clone. If the Test Suite Scripts folder is no longer included in the clone I have to alter the guides. A simple fix is to include the folder in the clone and, if you want, add it to a wsl subfolder as well. That way everything can be in one place (wsl subfolder) and the guides/scripts can run as is since the folder would also be included in the clone.

[gitwjr]

I revised the revised QuickStart Guide md to reference the more detailed WAVE_WSL_User_Guide. User these in place of the two Guides above in the Test Suite Scripts folder. Assuming the Test Suite Scripts folder is in the repo and will be cloned the user will be able to find them both.
WAVE_WSL_QuickStart_Guide_v1.md
WAVE_WSL_QuickStart_Guide_v1.pdf

[gitwjr]

@louaybassbouss @FritzHeiden @cta-source
(this comment is a duplicate of one I posted in Issue 137)
I have prepared, but not initiated a full PR for the automated scripts including the test_suite_scripts folder (scripts, guides, etc.), revised TIPS for WSL, etc., including creating a fork on the STAGING branch, etc. The guides and one of the scripts have been modified so ignore the ones I loaded in PR148 since they have changed and that PR was not implementable anyway.

Should I proceed with creating the fork and PR? If no one wants it or thinks it is useful, I won't do it but I do think it is a lot easier and faster for WSL users/novices.

[gitwjr]

@louaybassbouss @FritzHeiden I think this PR got merged by mistake. It was master → staging
and contained only existing commits (#131 and the #146 merge), so merging it
just synced master into staging — none of the WSL2 scripts were in the diff.
They were attached to comments here rather than committed.

I'm opening a proper PR from a fork with the actual test_suite_scripts folder
and the README Tip update, targeting staging. I'll link it here shortly.

[gitwjr]

Opened #151 with the actual test_suite_scripts folder committed, plus the README
Tip update. Targeting staging.