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.

Sign up for GitHub

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

Jump to bottom

Update README.md #22

Merged
merged 1 commit into from
Oct 4, 2024
Merged

Update README.md #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 14 additions & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

## Compatible Systems

- Windows 10/11: WSL2 / Git BASH
- Windows 10/11: WSL2
- Mac ARM / Intel
- Linux
- Raspberry Pi 4
Expand Down Expand Up @@ -140,50 +140,36 @@ git pull origin
Then continue above with "Run the script".


## Advice for Windows users using Git BASH
## Advice for Windows users on installing Windows Subsystem for Linux version 2 (WSL2)

We provide some hints to have your Windows system ready to run the agent. The instructions below have been tested in Windows 11.
1. Open a **Command Prompt** terminal as an Administrator.

Execute the following steps in a PowerShell terminal:

1. Install [Git](https://git-scm.com/download/win) and Git Bash:
2. Run the following commands:

```bash
winget install --id Git.Git -e --source winget
dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart
```

2. Install Python 3.10:

```bash
winget install Python.Python.3.10
dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart
```

3. Close and re-open the PowerShell terminal.
3. Then restart the computer.

4. Install [Poetry](https://python-poetry.org/docs/):

```bash
curl.exe -sSL https://install.python-poetry.org | python -
```
4. Open a **Command Prompt** terminal.

5. Add Poetry to your user's path:
5. Make WSL2 the default version by running:

```bash
$existingUserPath = (Get-Item -Path HKCU:\Environment).GetValue("PATH", $null, "DoNotExpandEnvironmentNames")

$newUserPath = "$existingUserPath;$Env:APPDATA\Python\Scripts"

[System.Environment]::SetEnvironmentVariable("Path", $newUserPath, "User")
wsl --set-default-version 2
```

6. Install [Docker Desktop](https://www.docker.com/products/docker-desktop/):
6. Install Ubuntu 22.04 by running:

```bash
winget install -e --id Docker.DockerDesktop
wsl --install -d Ubuntu-22.04
```

7. Log out of your Windows session and then log back in.

8. Open [Docker Desktop](https://www.docker.com/products/docker-desktop/) and leave it opened in the background.
7. Follow the on-screen instructions and set a username and password for your Ubuntu installation.

Now, open a Git Bash terminal and follow the instructions in the "[Run the script](#run-the-script)" section as well as the subsequent sections. You might need to install Microsoft Visual C++ 14.0 or greater.
8. Install Docker Desktop and enable the WSL 2 backend by following the instructions from Docker [here](https://docs.docker.com/desktop/wsl/).
Loading