CP Editor – Installation

Docs: Download from Releases

Mon, 01 Jan 0001 00:00:00 +0000

You need to choose a version in the Releases , then download an asset according to your OS and install it.

Windows

Setup Version

The setup version needs to be installed on your machine. The setting files will be stored in the config directory on your system, and it will be visible in the list of installed programs on your system.

Download the setup.exe in the assets and install it.

Portable Version

The portable version can be executed without installation. The setting files will be stored in the same directory as the executable file, and you won’t see it in the list of installed programs on your system.

Download the portable.zip in the assets and unzip it to any directory you like.

Most Linux Distros

Download the AppImage in the assets, add execute permission to it (chmod +x <AppImagePath>), then run it.

Debian-based Linux Distros

On Debian-based Linux distributions (Ubuntu, Linux Mint, etc.) you can download the .deb package in the assets and run the command in the terminal:

sudo apt install <path to .deb package>

Then type your root password and agree with the installation. You can also use Gdebi or other graphical tools to install the deb package. Supported: Debian 10 Buster, Ubuntu 18.04 Bionic Beaver, Linux Mint 19 Tara, and newer versions of these distributions or the ones based on them.

macOS

Download the .dmg file in the assets and install it.

You may need to click “Yes” to access Filesystem several times. Apple may report that this application does not come from a recognized developer and prevent you from launching the app. Please add an exception to CP Editor from System Preferences -> Security & Privacy -> General, and allow CP Editor to run anyways

Docs: Use package managers

Mon, 01 Jan 0001 00:00:00 +0000

Packaging status

Some of the packages are officially maintained while most of them are maintained by the community.

However, at present, CP Editor is not available in many package repositories. Package maintainers can contact us if any help is needed. For example, we may add some scripts in our CI/CD workflow.

Here are a few guidelines to install the packages.

Snapcraft

You can use Snapcraft to install cpeditor , which is available on most Linux distros.

There are two channels available: latest/stable and latest/edge.

Due to technical reasons, it was published using classic confinement, so you’ll need the --classic option to install it.

To install the latest stable version: sudo snap install cpeditor --classic

To install the latest alpha version: sudo snap install cpeditor --classic --channel=latest/edge

AUR

If you are using Arch Linux , it’s recommended to install CP Editor via AUR . AUR usually also works on Arch-based distros like Manjaro, but it sometimes fails due to reasons like different main repositories.

There are two AUR packages for CP Editor: cpeditor for the stable version and cpeditor-git for the alpha version.

If you are unfamiliar with AUR, it’s recommended to install paru and use paru -S cpeditor to install. You can also read the wiki on how to manually install an AUR package or AUR helpers .

After the installation, you’ll be able to run CP Editor by cpeditor in your terminal or launch from the start menu like other apps.

Docs: Build from source

Mon, 01 Jan 0001 00:00:00 +0000

Preparation

Clone this repo and submodules:

git clone --recurse-submodules https://github.com/cpeditor/cpeditor.git
# or alternatively in two separate commands
# git clone https://github.com/cpeditor/cpeditor.git
# git submodule update --init --recursive
cd cpeditor

Install Qt (5.15), CMake (3.12 or higher) and Python3 .
- On some Linux distributions and macOS, you can install from your package manager. For example, sudo pacman -S qt5-base on Arch Linux, brew install qt@5 on macOS.
- You can also use aqtinstall to install Qt.
If CMake can’t find the Qt installation path, you should set the environment variable: CMAKE_PREFIX_PATH=%QtPath%/%QtVersion%/%Compiler%/lib/cmake. For example, on macOS, you can run something like export CMAKE_PREFIX_PATH="/usr/local/Cellar/qt/5.15.2".

Install Extra CMake Modules and KDE (kf5) Syntax Highlighting . These are not bundled as submodules and must be installed on the host system before building.

On some Linux distributions and macOS, you can install from your package manager. For example, sudo pacman -S syntax-highlighting5 on Arch Linux, Homebrew KDE and then brew install kde-mac/kde/kf5-syntax-highlighting on macOS.

Otherwise, you can clone and build them manually:

git clone --branch kf5 https://github.com/KDE/extra-cmake-modules.git
cd extra-cmake-modules
cmake -B build -S . -DBUILD_HTML_DOCS=OFF -DBUILD_MAN_DOCS=OFF -DBUILD_QTHELP_DOCS=OFF -DBUILD_TESTING=OFF
cmake --build build --config Release --target install # may require sudo
cd ..

git clone --branch kf5 https://github.com/KDE/syntax-highlighting.git
cd syntax-highlighting
cmake -B build -S . -DBUILD_HTML_DOCS=OFF -DBUILD_MAN_DOCS=OFF -DBUILD_QTHELP_DOCS=OFF -DBUILD_TESTING=OFF
cmake --build build --config Release --target install # may require sudo
cd ..

Build

Linux/macOS:

cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build

Windows:

cmake -S . -B build
cmake --build build --config Release

On Linux, you will get build/cpeditor.

On macOS, you will get build/cpeditor.app.

On Windows, you will get build\cpeditor.exe, or build\Release\cpeditor.exe. If DLLs are missing, you can add %QtPath%\%QtVersion%\%Compiler%\bin (for example, D:\Qt\5.15.2\msvc2019_64\bin) to the PATH environmental variable.

Docs: Use Artifacts

Mon, 01 Jan 0001 00:00:00 +0000

If you want to use the latest version (even later than the beta release), but don’t want to build from source, you can download Artifacts from GitHub Actions .

However, it’s not recommended to use Artifacts, they are more unstable than beta releases, and could be a work in progress. You should read the commit logs and even the source codes before using Artifacts.

To run it on Windows/macOS, you should install from Releases first (usually any version is OK unless something like DLL missing happens). On Windows, replace cpeditor.exe in your install folder with the Artifact. On macOS, run cp path/to/Artifact cpeditor.app/Contents/MacOs, where cpeditor.app is the one already installed on your machine.

To run it on Ubuntu 18.04, you need to install Qt. Other Linux distributions may not support binaries compiled on Ubuntu 18.04.