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

Commit 3c507fe

Browse files
committed
docs: different between nightly, beta and stablt
1 parent ee97382 commit 3c507fe

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

docs/docs/installation.mdx

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,13 @@ import Admonition from '@theme/Admonition';
2020
- Binary files without package management.
2121

2222
### Cortex.cpp supports three channels
23+
2324
- Stable: The latest stable release on github.
2425
- Beta: The release candidate for the next stable release, available on github release with the tag `vx.y.z-rc1`
2526
- Nightly: The nightly build of the latest code on dev branch, available on [discord](https://discord.com/channels/1107178041848909847/1283654073488379904).
2627

28+
For more information, please check out [different channels](#different-channels).
29+
2730
### Download URLs
2831

2932
| Type | Version | Operating System | Download Link |
@@ -78,4 +81,29 @@ Having at least 6GB VRAM when using NVIDIA, AMD, or Intel Arc GPUs is recommende
7881
- [CUDA Toolkit](https://developer.nvidia.com/cuda-toolkit) version 12.0 or higher. *Note: Cortex.cpp will automatically detect and install the required version of cudart to the user's machine.*
7982
:::
8083
#### Disk
81-
- At least 10GB for app storage and model download.
84+
- At least 10GB for app storage and model download.
85+
86+
## Different channels
87+
88+
Different channels have different features, stability levels, binary file name, app folder and data folder.
89+
90+
### Stable
91+
- App name: `cortexcpp`
92+
- Binary file name: `cortex`, `cortex-server` for linux and mac; `cortex.exe`, `cortex-server.exe` for windows.;
93+
- App folder (Windows Only): `C:\Users\<username>\AppData\Local\cortexcpp`
94+
- Data folder: `~/cortexcpp` for linux and mac; `C:\Users\<username>\cortexcpp` for windows.
95+
- Uninstaller script (Mac Only): `cortex-uninstall.sh`
96+
97+
### Beta
98+
- App name: `cortexcpp-beta`
99+
- Binary file name: `cortex-beta`, `cortex-server-beta` for linux and mac; `cortex-beta.exe`, `cortex-server-beta.exe` for windows.;
100+
- App folder (Windows Only): `C:\Users\<username>\AppData\Local\cortexcpp-beta`
101+
- Data folder: `~/cortexcpp-beta` for linux and mac; `C:\Users\<username>\cortexcpp-beta` for windows.
102+
- Uninstaller script (Mac Only): `cortex-beta-uninstall.sh`
103+
104+
### Nightly
105+
- App name: `cortexcpp-nightly`
106+
- Binary file name: `cortex-nightly`, `cortex-server-nightly` for linux and mac; `cortex-nightly.exe`, `cortex-server-nightly.exe` for windows.;
107+
- App folder (Windows Only): `C:\Users\<username>\AppData\Local\cortexcpp-nightly`
108+
- Data folder: `~/cortexcpp-nightly` for linux and mac; `C:\Users\<username>\cortexcpp-nightly` for windows.
109+
- Uninstaller script (Mac Only): `cortex-nightly-uninstall.sh`

0 commit comments

Comments
 (0)