Skip to content

Update README.md about windows symlink fix #5766

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

Merged
merged 2 commits into from
May 8, 2025

Conversation

arihant2math
Copy link
Collaborator

No description provided.

@youknowone youknowone added the skip:ci Skip running the ci label May 1, 2025
README.md Outdated
@@ -31,6 +31,11 @@ To build RustPython locally, first, clone the source code:
git clone https://github.com/RustPython/RustPython
```

If on windows, run the following to fix the `Lib/` directory symlink:
Copy link
Member

@youknowone youknowone May 1, 2025

Choose a reason for hiding this comment

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

Suggested change
If on windows, run the following to fix the `Lib/` directory symlink:
RustPython uses symlinks to manage python libraries in `Lib/`. If on windows, running the following helps:

Does this make sense?

Also, as I know windows developer mode allows user to create symbolic links. Do you know if it also can be an alternative option of this?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'm not sure, this solution worked very well for me though.

Copy link
Member

Choose a reason for hiding this comment

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

@coolreader18 how about you? Is mentioning developer mode symbolic links support a correct description?

Copy link
Member

Choose a reason for hiding this comment

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

I think this makes sense, I'm pretty sure setting core.symlinks makes git make real symlinks using developer mode.

Co-authored-by: Jeong, YunWon <69878+youknowone@users.noreply.github.com>
@arihant2math arihant2math requested a review from youknowone May 5, 2025 00:37
@youknowone youknowone merged commit 9bd7f18 into RustPython:main May 8, 2025
7 checks passed
@arihant2math arihant2math deleted the patch-1 branch May 8, 2025 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip:ci Skip running the ci
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants