diff --git a/README.md b/README.md index 3cc1353c8..5ea0e76ef 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,158 @@ Cortex.cpp is a multi-engine that uses `llama.cpp` as the default engine but als ## Installation -You can install a nightly (unstable) version of Cortex from Discord here: https://discord.gg/nGp6PMrUqS +### Download + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Version TypeWindowsMacOSLinux
Stable (Recommended) + + + Coming soon + + + + + Coming soon + + + + + Coming soon + + + + + Coming soon + + + + + Coming soon + + + + + Coming soon + +
Beta (Preview) + + + cortex-local-installer.exe + + + + + cortex-network-installer.exe + + + + + cortex-local-installer.pkg + + + + + cortex-network-installer.pkg + + + + + cortex-local-installer.deb + + + + + cortex-network-installer.deb + +
Nightly Build (Experimental) + + + cortex-local-installer.exe + + + + + cortex-network-installer.exe + + + + + cortex-local-installer.pkg + + + + + cortex-network-installer.pkg + + + + + cortex-local-installer.deb + + + + + cortex-network-installer.deb + +
+ +### Instructions + +The local installer packages all required dependencies inside the installer itself, so you don’t need an internet connection during the installation process. +The network installer downloads the necessary dependencies from the internet during the installation. This option provides a smaller installer, but requires an internet connection. + +After installation, you can run Cortex.cpp from the command line by typing `cortex --help`. For beta and nightly builds, you can run `cortex-beta --help` and `cortex-nightly --help` respectively. + +#### Windows and MacOS + +Download the installer and double-click to the exe file to start the installation process. Follow the on-screen instructions to complete the installation. + +For MacOS, there is a uninstaller script comes with the binary and added to the `/usr/local/bin/` directory. The script is named `cortex-uninstall.sh` for stable builds, `cortex-beta-uninstall.sh` for beta builds and `cortex-nightly-uninstall.sh` for nightly builds. + +#### Linux + +Download the installer and run the following command in the terminal: + +```bash + sudo apt install ./cortex-local-installer.deb + # or + sudo apt install ./cortex-network-installer.deb +``` + +The binary will be installed in the `/usr/bin/` directory. ## Built-in Model Library @@ -65,18 +216,29 @@ Cortex.cpp includes a REST API accessible at `localhost:3928`. For a complete li ## Uninstallation ### Windows -1. Navigate to `Add or Remove Programs`. -2. Search for Cortex.cpp and click `Uninstall`. +1. Open the Windows Control Panel. +2. Navigate to `Add or Remove Programs`. +3. Search for `cortexcpp` and double click to uninstall. (for beta and nightly builds, search for `cortexcpp-beta` and `cortexcpp-nightly` respectively) ### MacOs Run the uninstaller script: ```bash +# For stable builds sudo sh cortex-uninstall.sh +# For beta builds +sudo sh cortex-beta-uninstall.sh +# For nightly builds +sudo sh cortex-nightly-uninstall.sh ``` ### Linux ```bash +# For stable builds sudo apt remove cortexcpp +# For beta builds +sudo apt remove cortexcpp-beta +# For nightly builds +sudo apt remove cortexcpp-nightly ``` ### Build from Source