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

[Documentation] Installation instructions: mention OS, tips for Windows/Linux/MacOS ? #160

Closed
vincentelfving opened this issue Nov 3, 2023 · 3 comments · Fixed by #625
Closed
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@vincentelfving
Copy link
Collaborator

After discussing with some of the recent users of qadence, I realized we are not yet mentioning any specifics on installation. It is assumed that the user has Linux or MacOS running and then everything will be fine (I think). For GraphViz there are specific instructions for Ubuntu and MacOS.

Suggestion: Let's add an explanation in the README/documentation, which states that we have tested and support Linux and MacOS currently, and that we recommend either WSL2 or dual-booting for those running Windows. We could add a link to a trusted/clear WSL2 installation guide or a super short intro to it. What do you think?

@madagra madagra added the documentation Improvements or additions to documentation label Nov 6, 2023
@madagra madagra self-assigned this Nov 6, 2023
@madagra
Copy link
Collaborator

madagra commented Nov 6, 2023

Those instructions are actually already available: https://pasqal-io.github.io/qadence/v1.0.4/#installation-guide. Normally, this kind of instruction should not be mentioned in the code documentation (since they are very much user/system dependent even if you have the same operating system) but adding a link to a good WSL guide + being more explicit is a good idea.

@RolandMacDoland
Copy link
Collaborator

Moving to backlog.

@RolandMacDoland RolandMacDoland changed the title Installation instructions: mention OS, tips for Windows/Linux/MacOS ? [Documentation] Installation instructions: mention OS, tips for Windows/Linux/MacOS ? Feb 7, 2024
@mlahariya
Copy link
Collaborator

Worth investigating. Install on different platforms and document behaviors.
We can close if everything works fine. @RolandMacDoland

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants