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

chore: correct build steps #1578

Merged
merged 3 commits into from
Nov 4, 2024
Merged

chore: correct build steps #1578

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c6446f7
chore: correct build steps
vansangpfiev Oct 30, 2024
959e1ad
chore: more
vansangpfiev Oct 30, 2024
21aedc7
Revert "chore: more"
vansangpfiev Oct 30, 2024
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
28 changes: 13 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ Cortex.cpp is available with a Network Installer, which is a smaller installer b
#### Windows

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

```bash
Expand All @@ -275,16 +275,16 @@ cd vcpkg
vcpkg install
```

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

```bash
mkdir build
cd build
cmake .. -DBUILD_SHARED_LIBS=OFF -DCMAKE_TOOLCHAIN_FILE=path_to_vcpkg_folder/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-windows-static
cmake .. -DBUILD_SHARED_LIBS=OFF -DCMAKE_TOOLCHAIN_FILE=path_to_vcpkg_folder_in_cortex_repo/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-windows-static
cmake --build . --config Release
```

5. Use Visual Studio with the C++ development kit to build the project using the files generated in the `build` folder.
6. Verify that Cortex.cpp is installed correctly by getting help information.
5. Verify that Cortex.cpp is installed correctly by getting help information.

```sh
# Get the help information
Expand All @@ -294,7 +294,7 @@ cortex -h
#### MacOS

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

```bash
Expand All @@ -303,17 +303,16 @@ cd vcpkg
vcpkg install
```

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

```bash
mkdir build
cd build
cmake .. -DCMAKE_TOOLCHAIN_FILE=path_to_vcpkg_folder/vcpkg/scripts/buildsystems/vcpkg.cmake
cmake .. -DCMAKE_TOOLCHAIN_FILE=path_to_vcpkg_folder_in_cortex_repo/vcpkg/scripts/buildsystems/vcpkg.cmake
make -j4
```

5. Use Visual Studio with the C++ development kit to build the project using the files generated in the `build` folder.
6. Verify that Cortex.cpp is installed correctly by getting help information.
5. Verify that Cortex.cpp is installed correctly by getting help information.

```sh
# Get the help information
Expand All @@ -323,7 +322,7 @@ cortex -h
#### Linux

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

```bash
Expand All @@ -332,17 +331,16 @@ cd vcpkg
vcpkg install
```

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

```bash
mkdir build
cd build
cmake .. -DCMAKE_TOOLCHAIN_FILE=path_to_vcpkg_folder/vcpkg/scripts/buildsystems/vcpkg.cmake
cmake .. -DCMAKE_TOOLCHAIN_FILE=path_to_vcpkg_folder_in_cortex_repo/vcpkg/scripts/buildsystems/vcpkg.cmake
make -j4
```

5. Use Visual Studio with the C++ development kit to build the project using the files generated in the `build` folder.
6. Verify that Cortex.cpp is installed correctly by getting help information.
5. Verify that Cortex.cpp is installed correctly by getting help information.

```sh
# Get help
Expand Down