Skip to content

docs: add WSL evdev installation note#2855

Merged
imstevenpmwork merged 2 commits into
huggingface:mainfrom
DominikPalo:docs/add-wsl2-installation-note
Feb 23, 2026
Merged

docs: add WSL evdev installation note#2855
imstevenpmwork merged 2 commits into
huggingface:mainfrom
DominikPalo:docs/add-wsl2-installation-note

Conversation

@DominikPalo

@DominikPalo DominikPalo commented Jan 26, 2026

Copy link
Copy Markdown
Contributor

Title

docs: add WSL evdev installation note

Type / Scope

  • Type: Docs
  • Scope: installation

Summary / Motivation

Add a note in the installation guide explaining that users on WSL need to install evdev to avoid build issues. Without installing evdev, the installation fails with the Building wheel for evdev (pyproject.toml) did not run successfully.

Related issues

What changed

Added a note to the documentation.

How was this tested (or how to run locally)

Successfully installed LeRobot on two different Windows computers inside WSL2 (Ubuntu), both from sources (pip install -e .) and using PiPY (pip install lerobot).

Checklist (required before merge)

  • Linting/formatting run (pre-commit run -a)
  • All tests pass locally (pytest)
  • Documentation updated
  • CI is green

Add a note in the installation guide explaining that users on WSL need to install evdev to avoid build issues.
See: huggingface#2528
@github-actions github-actions Bot added the documentation Improvements or fixes to the project’s docs label Jan 26, 2026
@CarolinePascal

Copy link
Copy Markdown
Collaborator

Hi @DominikPalo,

Thank you for the contribution, I tried the fix on my side and it worked well ! A bit of nit picking before the merge :

  • If possible and not breaking, could you change the syntax to conda install evdev -c conda-forge to match the ffmpeg install command ?
  • Could you also clearly state that WSL users will install evdev by running this command ? e.g. "Make sure to install evdev with the following command".
    Thanks you ! Feel free to ping me when the changes are added :)

Best,

Caroline.

@imstevenpmwork imstevenpmwork self-requested a review February 9, 2026 12:31
@imstevenpmwork imstevenpmwork self-assigned this Feb 9, 2026
Signed-off-by: Steven Palma <imstevenpmwork@ieee.org>

@imstevenpmwork imstevenpmwork left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM, thanks for the contribution!

@HuggingFaceDocBuilderDev

Copy link
Copy Markdown

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@imstevenpmwork imstevenpmwork merged commit 7fd71c8 into huggingface:main Feb 23, 2026
9 checks passed
xianglunkai pushed a commit to xianglunkai/lerobot that referenced this pull request Feb 28, 2026
Add a note in the installation guide explaining that users on WSL need to install evdev to avoid build issues.
See: huggingface#2528

Signed-off-by: Steven Palma <imstevenpmwork@ieee.org>
Co-authored-by: Steven Palma <imstevenpmwork@ieee.org>
sorelferris pushed a commit to sorelferris/lerobot that referenced this pull request Mar 1, 2026
Add a note in the installation guide explaining that users on WSL need to install evdev to avoid build issues.
See: huggingface#2528

Signed-off-by: Steven Palma <imstevenpmwork@ieee.org>
Co-authored-by: Steven Palma <imstevenpmwork@ieee.org>
lu391see pushed a commit to lu391see/lerobot_tactile that referenced this pull request Mar 24, 2026
Add a note in the installation guide explaining that users on WSL need to install evdev to avoid build issues.
See: huggingface#2528

Signed-off-by: Steven Palma <imstevenpmwork@ieee.org>
Co-authored-by: Steven Palma <imstevenpmwork@ieee.org>
zouxiaochuan pushed a commit to magic-visual-plus/lerobot that referenced this pull request May 20, 2026
Add a note in the installation guide explaining that users on WSL need to install evdev to avoid build issues.
See: huggingface#2528

Signed-off-by: Steven Palma <imstevenpmwork@ieee.org>
Co-authored-by: Steven Palma <imstevenpmwork@ieee.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or fixes to the project’s docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

cannot install lerobot in WSL

4 participants