C++ JavaScript QMake HTML Shell CSS Other

README.md

Notepadqq Notepadqq Build Status Snap Status

Links

What is it?

Notepadqq is a text editor designed from developers, for developers.

screenshot_20180302_163505

Please visit our Wiki for more screenshots and details.

Build it yourself

Build dependencies Dependencies
Qt 5.6 or higher Qt 5.6 or higher
qtwebengine5-dev qtwebengine5
libqt5websockets5-dev libqt5websockets5
libqt5svg5-dev libqt5svg5
qttools5-dev-tools coreutils

Get the source

$ git clone --recursive https://github.com/notepadqq/notepadqq.git
$ cd notepadqq

Build

notepadqq$ ./configure --prefix /usr
notepadqq$ make

If you encounter errors make sure to have the necessary libraries installed. For Ubuntu you can do that using apt-get:

notepadqq$ sudo apt-get install qt5-default qttools5-dev-tools qtwebengine5-dev libqt5websockets5-dev libqt5svg5 libqt5svg5-dev

For CentOS:

notepadqq$ sudo yum install -y qt5-qtbase-devel qt5-qttools-devel qt5-qtwebengine-devel qt5-qtwebsockets-devel qt5-qtsvg-devel

Install

You can run notepadqq from its build output folder. If however you want to install it, first build it by following the above steps, then run

notepadqq$ sudo make install

Qt

If the newest version of Qt isn't available on your distribution, you can use the online installer to get the latest libraries and install them into your home directory ($HOME/Qt). Notepadqq will automatically use them.

Distribution Packages

Most distributions: Snap (recommended)

To install the latest stable version:

sudo snap install --classic notepadqq

You don't have the snap command? Follow the instructions at https://docs.snapcraft.io/core/install and then install Notepadqq as shown above.

You can follow the unstable development releases from the "edge" channel.

Launchpad PPA

You should prefer using Snap packages, which are natively supported on Ubuntu (see above). Anyway, Notepadqq is also available from an official PPA:

sudo add-apt-repository ppa:notepadqq-team/notepadqq
sudo apt-get update
sudo apt-get install notepadqq

Debian

Download a deb package from the Ubuntu PPA: download

Arch Linux (community-maintained)

Notepadqq is available from Arch's community repositories. To install using pacman:

sudo pacman -S notepadqq

Alternatively it can be found in the AUR:

OpenSUSE (community-maintained)

Notepadqq is avilable in OpenSUSE's main repository:

 sudo zypper in notepadqq

Solus (community-maintained)

Notepadqq is available in the shannon (stable) repository:

 sudo eopkg it notepadqq

Others

Use a package for a compatible distribution, or build from source. If you want to submit a package: https://github.com/notepadqq/notepadqq-packaging

Compiling on macOS

While we do not (yet) officially support it, compiling and running Notepadqq on macOS is not very difficult. Instructions can be found here.