Skip to content

Commit

Permalink
Merge branch 'main' into nico/fix_agent_comms
Browse files Browse the repository at this point in the history
  • Loading branch information
nicarq authored Oct 22, 2024
2 parents 4291e64 + 4cd7ae2 commit f2aebc4
Showing 1 changed file with 32 additions and 2 deletions.
34 changes: 32 additions & 2 deletions docs/installation/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ rustc --version

1. Download the [Protobuf release for Windows](https://github.com/protocolbuffers/protobuf/releases).
2. Extract the downloaded files and add the `bin` directory to your system's `PATH`.

For example, add `C:\path\to\protobuf\bin` to the `PATH` environment variable.

Verify installation:
Expand All @@ -44,12 +44,14 @@ protoc --version
On Windows, the easiest way to get OpenSSL is through [vcpkg](https://github.com/microsoft/vcpkg). Follow these steps:

1. Install [vcpkg](https://github.com/microsoft/vcpkg):

```powershell
git clone https://github.com/microsoft/vcpkg.git
.\vcpkg\bootstrap-vcpkg.bat
```

2. Install OpenSSL using vcpkg:

```powershell
.\vcpkg\vcpkg install openssl:x64-windows
```
Expand All @@ -66,4 +68,32 @@ Once all dependencies are installed, build the project with:

```powershell
cargo build
```
```

## Alternative Installation

For a smoother developer experience, setup WSL (Windows Subsystem for Linux) and install a Linux distribution.

### 1. Install WSL

Run the following command to install Ubuntu as the default distribution:

```powershell
wsl --install
```

Or run the following command to change the distribution installed:

```powershell
wsl --install -d <Distribution Name>
```

### 2. Install Shinkai Node

Enter the following command to step inside the installed Linux distribution:

```powershell
wsl
```

Follow the instructions in the **Quick Start Guide for Linux** documentation to install Shinkai Node in a Linux environment.

0 comments on commit f2aebc4

Please sign in to comment.