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

Clarify steps require for pixi installation #331

Merged
merged 4 commits into from
Jan 10, 2025
Merged

Conversation

traversaro
Copy link
Contributor

@traversaro traversaro commented Jan 8, 2025

I think the current installation instructions were a bit confusing, as pip and conda reported the instructions required for a downstream user to use jaxsim in their own project/environment, while the installation with pixi reported the instructions required for a contributor to use run a source installation from the jaxsim repo.

I tried to clarify this, probably it could make sense if also @younik could provide some feedback has it has the advantage of being a new users that it may not familiar with the project and provide some feedback from the point of view of a new user.


📚 Documentation preview 📚: https://jaxsim--331.org.readthedocs.build//331/

Copy link
Collaborator

@flferretti flferretti left a comment

Choose a reason for hiding this comment

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

Thanks a lot @traversaro, LGTM. I only added a small comment

README.md Outdated Show resolved Hide resolved
Copy link
Member

@younik younik left a comment

Choose a reason for hiding this comment

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

It looks clear to me!

It is not really related to this PR, but what is the purpose of [!NOTE]? It doesn't render in the GitHub README and I cannot find a related page in the documentation

Copy link
Member

@xela-95 xela-95 left a comment

Choose a reason for hiding this comment

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

Thanks @traversaro ! I left some comments, since with @younik we saw that the NOTE section inside a /details block is not rendered correctly.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@traversaro
Copy link
Contributor Author

It is not really related to this PR, but what is the purpose of [!NOTE]? It doesn't render in the GitHub README and I cannot find a related page in the documentation

It render fines outside of the <details> section, see https://github.com/orgs/community/discussions/16925 .

README.md Outdated Show resolved Hide resolved
@traversaro traversaro requested a review from xela-95 January 9, 2025 17:21
README.md Outdated Show resolved Hide resolved
@flferretti flferretti enabled auto-merge January 10, 2025 10:41
@flferretti flferretti merged commit 849d37e into main Jan 10, 2025
24 checks passed
@flferretti flferretti deleted the traversaro-patch-1 branch January 10, 2025 10:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants