Skip to content
This repository was archived by the owner on Jul 4, 2025. It is now read-only.

Improve "Build from Source" in README #1886

Merged
merged 1 commit into from
Feb 3, 2025
Merged

Improve "Build from Source" in README #1886

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
39 changes: 22 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,19 +313,26 @@ Cortex.cpp is available with a Network Installer, which is a smaller installer b

### Build from Source

Firstly, clone the Cortex.cpp repository [here](https://github.com/janhq/cortex.cpp) and initialize the submodules:

```bash
git clone https://github.com/janhq/cortex.cpp
cd cortex.cpp
git submodule update --init --recursive
```

#### Windows

1. Clone the Cortex.cpp repository [here](https://github.com/janhq/cortex.cpp).
2. Navigate to the `engine` folder.
3. Configure the vpkg:
1. Navigate to the `engine` folder.
2. Configure the vpkg:

```bash
cd vcpkg
./bootstrap-vcpkg.bat
vcpkg install
```

4. Build the Cortex.cpp inside the `engine/build` folder:
3. Build the Cortex.cpp inside the `engine/build` folder:

```bash
mkdir build
Expand All @@ -334,25 +341,24 @@ cmake .. -DBUILD_SHARED_LIBS=OFF -DCMAKE_TOOLCHAIN_FILE=path_to_vcpkg_folder_in_
cmake --build . --config Release
```

5. Verify that Cortex.cpp is installed correctly by getting help information.
4. Verify that Cortex.cpp is installed correctly by getting help information.

```sh
cortex -h
```

#### MacOS

1. Clone the Cortex.cpp repository [here](https://github.com/janhq/cortex.cpp).
2. Navigate to the `engine` folder.
3. Configure the vpkg:
1. Navigate to the `engine` folder.
2. Configure the vpkg:

```bash
cd vcpkg
./bootstrap-vcpkg.sh
vcpkg install
```

4. Build the Cortex.cpp inside the `engine/build` folder:
3. Build the Cortex.cpp inside the `engine/build` folder:

```bash
mkdir build
Expand All @@ -361,25 +367,24 @@ cmake .. -DCMAKE_TOOLCHAIN_FILE=path_to_vcpkg_folder_in_cortex_repo/vcpkg/script
make -j4
```

5. Verify that Cortex.cpp is installed correctly by getting help information.
4. Verify that Cortex.cpp is installed correctly by getting help information.

```sh
cortex -h
./cortex -h
```

#### Linux

1. Clone the Cortex.cpp repository [here](https://github.com/janhq/cortex.cpp).
2. Navigate to the `engine` folder.
3. Configure the vpkg:
1. Navigate to the `engine` folder.
2. Configure the vpkg:

```bash
cd vcpkg
./bootstrap-vcpkg.sh
vcpkg install
```

4. Build the Cortex.cpp inside the `engine/build` folder:
3. Build the Cortex.cpp inside the `engine/build` folder:

```bash
mkdir build
Expand All @@ -388,10 +393,10 @@ cmake .. -DCMAKE_TOOLCHAIN_FILE=path_to_vcpkg_folder_in_cortex_repo/vcpkg/script
make -j4
```

5. Verify that Cortex.cpp is installed correctly by getting help information.
4. Verify that Cortex.cpp is installed correctly by getting help information.

```sh
cortex -h
./cortex -h
```

#### Devcontainer / Codespaces
Expand Down