-
Notifications
You must be signed in to change notification settings - Fork 7.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into installer-osver-check
- Loading branch information
Showing
5 changed files
with
178 additions
and
135 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,109 +1,106 @@ | ||
| # Building gpt4all-chat from source | ||
|
|
||
| Depending upon your operating system, there are many ways that Qt is distributed. | ||
| Here is the recommended method for getting the Qt dependency installed to setup and build | ||
| gpt4all-chat from source. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| You will need a compiler. On Windows, you should install Visual Studio with the C++ Development components. On macOS, you will need the full version of Xcode—Xcode Command Line Tools lacks certain required tools. On Linux, you will need a GCC or Clang toolchain with C++ support. | ||
|
|
||
| On Windows and Linux, building GPT4All with full GPU support requires the [Vulkan SDK](https://vulkan.lunarg.com/sdk/home) and the latest [CUDA Toolkit](https://developer.nvidia.com/cuda-downloads). | ||
|
|
||
| ## Note for Linux users | ||
|
|
||
| Linux users may install Qt via their distro's official packages instead of using the Qt installer. You need at least Qt 6.5, with support for QPdf and the Qt HTTP Server. It should be straightforward to build with just cmake and make, but you may continue to follow these instructions to build with Qt Creator. | ||
|
|
||
| On Arch Linux, this looks like: | ||
| ``` | ||
| sudo pacman -S --needed base-devel qt6-base qt6-declarative qt6-wayland qt6-svg qt6-httpserver qt6-webengine qt6-5compat qt6-shadertools qtcreator cmake ninja | ||
| ``` | ||
|
|
||
| On Ubuntu 23.04, this looks like: | ||
| ``` | ||
| sudo apt install build-essential qt6-base-dev qt6-declarative-dev qt6-wayland-dev qt6-svg-dev qt6-httpserver-dev qt6-webengine-dev libqt6core5compat6 qml6-module-qt5compat-graphicaleffects libqt6shadertools6 qtcreator cmake ninja-build | ||
| ``` | ||
|
|
||
| On Fedora 39, this looks like: | ||
| ``` | ||
| sudo dnf install make gcc gcc-c++ qt6-qtbase-devel qt6-qtdeclarative-devel qt6-qtwayland-devel qt6-qtsvg-devel qt6-qthttpserver-devel qt6-qtwebengine-devel qt6-qt5compat qt5-qtgraphicaleffects qt6-qtshadertools qt-creator cmake ninja-build | ||
| ``` | ||
|
|
||
| ## Download Qt | ||
|
|
||
| - Go to https://login.qt.io/register to create a free Qt account. | ||
| - Download the Qt Online Installer for your OS from here: https://www.qt.io/download-qt-installer-oss | ||
| - Sign into the installer. | ||
| - Agree to the terms of the (L)GPL 3 license. | ||
| - Select whether you would like to send anonymous usage statistics to Qt. | ||
| - On the Installation Folder page, leave the default installation path, and select "Custom Installation". | ||
|
|
||
| ## Customize the installation | ||
|
|
||
|  | ||
|
|
||
| Under "Qt", find the latest Qt 6.x release. | ||
|
|
||
| Under this release (e.g. Qt 6.5.0), select the target platform: | ||
| - On macOS, it is just called "macOS". | ||
| - On Windows, it is called "MSVC 2019 64-bit" (for 64-bit x86 CPUs). MinGW has not been tested. | ||
|
|
||
| Under this release, select the following additional components: | ||
| - Qt Quick 3D | ||
| - Qt Wayland Compositor (for Linux only) | ||
| - Qt 5 Compatibility Module | ||
| - Qt Shader Tools | ||
| - Additional Libraries: | ||
| - Qt HTTP Server | ||
| - Qt PDF | ||
| - Qt Debug information Files | ||
|
|
||
| Under Developer and Designer Tools, select the following components: | ||
| - Qt Creator | ||
| - Qt Creator CDB Debugger Support (for Windows only) | ||
| - Debugging Tools for Windows (for Windows only) | ||
| - CMake | ||
| - Ninja | ||
|
|
||
| Agree to the license and complete the installation. | ||
|
|
||
| ## Download the source code | ||
|
|
||
| You must use git to download the source code for gpt4all: | ||
| ``` | ||
| git clone --recurse-submodules https://github.com/nomic-ai/gpt4all | ||
| ``` | ||
|
|
||
| Note the use of --recurse-submodules, which makes sure the necessary dependencies are downloaded inside the repo. This is why you cannot simply download a zip archive. | ||
|
|
||
| Windows users: To install git for Windows, see https://git-scm.com/downloads. Once it is installed, you should be able to shift-right click in any folder, "Open PowerShell window here" (or similar, depending on the version of Windows), and run the above command. | ||
|
|
||
| ## Open gpt4all-chat in Qt Creator | ||
|
|
||
| Open Qt Creator. Navigate to File > Open File or Project, find the "gpt4all-chat" folder inside the freshly cloned repository, and select CMakeLists.txt. | ||
|
|
||
|  | ||
|
|
||
| ## Configure project | ||
|
|
||
| You can now expand the "Details" section next to the build kit. It is best to uncheck all but one build configuration, e.g. "Release", which will produce optimized binaries that are not useful for debugging. | ||
|
|
||
| Click "Configure Project", and wait for it to complete. | ||
|
|
||
|  | ||
|
|
||
| ## Build project | ||
|
|
||
| Now that the project has been configured, click the hammer button on the left sidebar to build the project. | ||
|
|
||
|  | ||
|
|
||
| ## Run project | ||
|
|
||
| Click the play button on the left sidebar to run the Chat UI. | ||
|
|
||
|  | ||
|
|
||
| ## Updating the downloaded source code | ||
|
|
||
| You do not need to make a fresh clone of the source code every time. To update it, you may open a terminal/command prompt in the repository, run `git pull`, and then `git submodule update --init --recursive`. | ||
| # Building gpt4all-chat from source | ||
|
|
||
| Depending upon your operating system, there are many ways that Qt is distributed. | ||
| Here is the recommended method for getting the Qt dependency installed to setup and build | ||
| gpt4all-chat from source. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| You will need a compiler. On Windows, you should install Visual Studio with the C++ Development components. On macOS, you will need the full version of Xcode—Xcode Command Line Tools lacks certain required tools. On Linux, you will need a GCC or Clang toolchain with C++ support. | ||
|
|
||
| On Windows and Linux, building GPT4All with full GPU support requires the [Vulkan SDK](https://vulkan.lunarg.com/sdk/home) and the latest [CUDA Toolkit](https://developer.nvidia.com/cuda-downloads). | ||
|
|
||
| ## Note for Linux users | ||
|
|
||
| Linux users may install Qt via their distro's official packages instead of using the Qt installer. You need at least Qt 6.5, with support for QPdf and the Qt HTTP Server. You may build from the CLI using CMake and Ninja, or with Qt Creator as described later in this document. | ||
|
|
||
| On Arch Linux, this looks like: | ||
| ``` | ||
| sudo pacman -S --needed cmake gcc ninja qt6-5compat qt6-base qt6-declarative qt6-httpserver qt6-svg qtcreator | ||
| ``` | ||
|
|
||
| On Ubuntu 23.04, this looks like: | ||
| ``` | ||
| sudo apt install cmake g++ libgl-dev libqt6core5compat6 ninja-build qml6-module-qt5compat-graphicaleffects qt6-base-dev qt6-declarative-dev qt6-httpserver-dev qt6-svg-dev qtcreator | ||
| ``` | ||
|
|
||
| On Fedora 39, this looks like: | ||
| ``` | ||
| sudo dnf install cmake gcc-c++ ninja-build qt-creator qt5-qtgraphicaleffects qt6-qt5compat qt6-qtbase-devel qt6-qtdeclarative-devel qt6-qthttpserver-devel qt6-qtsvg-devel | ||
| ``` | ||
|
|
||
| ## Download Qt | ||
|
|
||
| - Go to https://login.qt.io/register to create a free Qt account. | ||
| - Download the Qt Online Installer for your OS from here: https://www.qt.io/download-qt-installer-oss | ||
| - Sign into the installer. | ||
| - Agree to the terms of the (L)GPL 3 license. | ||
| - Select whether you would like to send anonymous usage statistics to Qt. | ||
| - On the Installation Folder page, leave the default installation path, and select "Custom Installation". | ||
|
|
||
| ## Customize the installation | ||
|
|
||
|  | ||
|
|
||
| Under "Qt", find the latest Qt 6.x release. | ||
|
|
||
| Under this release (e.g. Qt 6.5.0), select the target platform: | ||
| - On macOS, it is just called "macOS". | ||
| - On Windows, it is called "MSVC 2019 64-bit" (for 64-bit x86 CPUs). MinGW has not been tested. | ||
|
|
||
| Under this release, select the following additional components: | ||
| - Qt 5 Compatibility Module | ||
| - Additional Libraries: | ||
| - Qt HTTP Server | ||
| - Qt PDF | ||
| - Qt Debug information Files | ||
|
|
||
| Under Developer and Designer Tools, select the following components: | ||
| - Qt Creator | ||
| - Qt Creator CDB Debugger Support (for Windows only) | ||
| - Debugging Tools for Windows (for Windows only) | ||
| - CMake | ||
| - Ninja | ||
|
|
||
| Agree to the license and complete the installation. | ||
|
|
||
| ## Download the source code | ||
|
|
||
| You must use git to download the source code for gpt4all: | ||
| ``` | ||
| git clone --recurse-submodules https://github.com/nomic-ai/gpt4all | ||
| ``` | ||
|
|
||
| Note the use of --recurse-submodules, which makes sure the necessary dependencies are downloaded inside the repo. This is why you cannot simply download a zip archive. | ||
|
|
||
| Windows users: To install git for Windows, see https://git-scm.com/downloads. Once it is installed, you should be able to shift-right click in any folder, "Open PowerShell window here" (or similar, depending on the version of Windows), and run the above command. | ||
|
|
||
| ## Open gpt4all-chat in Qt Creator | ||
|
|
||
| Open Qt Creator. Navigate to File > Open File or Project, find the "gpt4all-chat" folder inside the freshly cloned repository, and select CMakeLists.txt. | ||
|
|
||
|  | ||
|
|
||
| ## Configure project | ||
|
|
||
| You can now expand the "Details" section next to the build kit. It is best to uncheck all but one build configuration, e.g. "Release", which will produce optimized binaries that are not useful for debugging. | ||
|
|
||
| Click "Configure Project", and wait for it to complete. | ||
|
|
||
|  | ||
|
|
||
| ## Build project | ||
|
|
||
| Now that the project has been configured, click the hammer button on the left sidebar to build the project. | ||
|
|
||
|  | ||
|
|
||
| ## Run project | ||
|
|
||
| Click the play button on the left sidebar to run the Chat UI. | ||
|
|
||
|  | ||
|
|
||
| ## Updating the downloaded source code | ||
|
|
||
| You do not need to make a fresh clone of the source code every time. To update it, you may open a terminal/command prompt in the repository, run `git pull`, and then `git submodule update --init --recursive`. |
Oops, something went wrong.