Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Installation for Windows docs improved #413

Merged
merged 11 commits into from May 13, 2024

Conversation

jjfumero
Copy link
Member

Description

Improve the documentation for the installation of TornadoVM on Windows 10/11

Problem description

n/ a.

Backend/s tested

Mark the backends affected by this PR.

  • OpenCL
  • PTX
  • SPIRV

OS tested

Mark the OS where this PR is tested.

  • Linux
  • OSx
  • Windows

Did you check on FPGAs?

If it is applicable, check your changes on FPGAs.

  • Yes
  • No

How to test the new patch?

Link to the documentation.

@jjfumero jjfumero added the documentation Documentation label May 10, 2024
@jjfumero jjfumero self-assigned this May 10, 2024
docs/source/installation.rst Outdated Show resolved Hide resolved
docs/source/installation.rst Outdated Show resolved Hide resolved
docs/source/installation.rst Outdated Show resolved Hide resolved
docs/source/installation.rst Outdated Show resolved Hide resolved
docs/source/installation.rst Outdated Show resolved Hide resolved
cd %USERPROFILE%\MyProjects\TornadoVM
etc/setvars.cmd
nmake /f Makefile.mak graal-jdk-21 BACKEND=opencl,ptx
cd %USERPROFILE%\MyProjects
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this path may not exist for every user.

docs/source/installation.rst Outdated Show resolved Hide resolved
python -m venv .venv
.venv\Scripts\activate.bat
.\bin\windowsMicrosoftStudioTools2022.cmd
python bin\tornadovm-installer --jdk jdk21 --backend=opencl
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this command should change to be:

nmake /f Makefile.mak jdk21 BACKEND=opencl,ptx

The reason is that we are in the section of the manual installation, so we should point to the manual build command.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think in the feature we should only allow to install through the installer script. For now, let's maintain the nmake approach as well. I will change this.

docs/source/installation.rst Outdated Show resolved Hide resolved
jjfumero and others added 7 commits May 13, 2024 09:37
Co-authored-by: Thanos Stratikopoulos <34061419+stratika@users.noreply.github.com>
Co-authored-by: Thanos Stratikopoulos <34061419+stratika@users.noreply.github.com>
Co-authored-by: Thanos Stratikopoulos <34061419+stratika@users.noreply.github.com>
Co-authored-by: Thanos Stratikopoulos <34061419+stratika@users.noreply.github.com>
Co-authored-by: Thanos Stratikopoulos <34061419+stratika@users.noreply.github.com>
Co-authored-by: Thanos Stratikopoulos <34061419+stratika@users.noreply.github.com>
@jjfumero
Copy link
Member Author

All comments resolved.

@jjfumero jjfumero merged commit 3ae7d07 into beehive-lab:develop May 13, 2024
2 checks passed
@jjfumero jjfumero deleted the docs/windows/installer branch May 13, 2024 08:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation
Projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants