Include a Windows header under the installation instructions page

[devskillz47]

Problem
'tremor' is not recognized as an internal or external command,
operable program or batch file.

Steps

1. Download and unpack (tremor-0.12.4-x86_64-unknown-linux-gnu.tar.gz) directly on windows
2. Execute "tremor server run"

Possible Solution(s)

• installation instructions should specify that for windows users, it is recommended that tremor should be installed under WSL.

Output of rustup --version:
rustup 1.27.1 (54dd3d00f 2024-04-24)
info: This is the version for the rustup toolchain manager, not the rustc compiler.
info: The currently active rustc version is rustc 1.81.0 (eeb90cda1 2024-09-04)

Output of rustup show:
Default host: x86_64-pc-windows-msvc
rustup home: C:\Users\Petri.rustup
stable-x86_64-pc-windows-msvc (default)
rustc 1.81.0 (eeb90cda1 2024-09-04)

Output of tremor --version:
bash: tremor: command not found

[darach]

Good catch.

Currently tremor fails to build on windows natively as we use UNIX signal handling via the tokio libraries
and this constrains tremor to running on Mac OS X, Linux or UNIX derivatives. This means features like
UNIX streams or UNIX style signal handling would need to be avoided on native windows or worked around
or adapted in some way. That work ( adaptation for windows ) is not done.

We do not currently have Tremor on Windows subsystem for Linux documentation as most experienced
WSL users ( or experienced programmers ) will know to use the UNIX/Linux documentation.

However, this is still a getting started issue for folk new to windows and new to WSL or perhaps new to
programming in general.

As this is a bug of omission, enhancing our docs by adding the missing guide should hopefully provide a
set of steps for those that needed it.

Thank you for raising and opening this issue!

[devskillz47]

I was thinking to just specify under the windows header that it is recommended to install tremor under wsl by following the Unix guidelines- we have it specified on other pages just not on the installation instructions one. :p Unfortunately, I kept scrolling up and down the page a few minutes the first time, trying to find the installation instructions for windows until I saw it mentioned somewhere else. :p

…

On Wed, 20 Nov 2024, 15:04 Darach Ennis, ***@***.***> wrote: Good catch. Currently tremor fails to build on windows natively as we use UNIX signal handling via the tokio libraries and this constrains tremor to running on Mac OS X, Linux or UNIX derivatives. This means features like UNIX streams or UNIX style signal handling would need to avoided on native windows. We do not currently have Tremor on Windows subsystem for Linux documentation as most experienced WSL users ( or experienced programmers ) will know to use the UNIX/Linux documentation. However, this is still a getting started issue for folk new to windows and new to WSL or perhaps new to programming in general. As this is a bug of omission, enhancing our docs by adding the missing guide should hopefully provide a set of steps for those that needed it. Thank you for raising and opening this issue! — Reply to this email directly, view it on GitHub <#335 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AOAGJARFNGNW3ZLAHKRZ3F32BSCE5AVCNFSM6AAAAABSEQJ2CCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIOBYGUZTCNJXHE> . You are receiving this because you authored the thread.Message ID: ***@***.***>