vnote/en_us/docs/Developers/Build VNote.md

Build VNote

You need Qt 5.12 and above to build VNote from source.

Get the Source Code of VNote

VNote's source code is available on GitHub. You could download the ZIP archive of the code. Please be aware of that VNote depends on some submodules, so you should also download the source codes of these modules.

The recommended way is using git like this:

git clone https://github.com/vnotex/vnote.git vnote.git
cd vnote.git
git submodule update --init --recursive

Get Qt 5.12

You could get the standalone Qt SDK from Qt Downloads. For users in China, you could speed up the download via the TUNA Mirrors.

Windows

On Windows, you need Visual Studio 2015 or above to compile VNote (Mingw is not supported).

Open Qt Creator and open vnote.git\vnote.pro as project. Now you are ready to tune and compile VNote!

Linux

In Ubuntu, you could get Qt 5.12 from PPA like this:

sudo add-apt-repository ppa:beineri/opt-qt-5.12.10-bionic -y
sudo apt-get update -qq
sudo apt-get -y install qt512base qt512webengine
sudo apt-get -y install qt512webchannel qt512svg qt512location qt512tools qt512translations
source /opt/qt*/bin/qt*-env.sh

Then compile and install VNote like this:

cd vnote.git
mkdir build
cd build
qmake ../vnote.pro
make
sudo make install

Fcitx

If you use Fcitx as the input method, you need to copy the missing library libfcitxplatforminputcontextplugin.so to Qt's plugin directory.

To find the place of libfcitxplatforminputcontextplugin.so, you could execute:

fcitx-diagnose | grep libfcitxplatforminputcontextplugin.so

If there is no such lib, you may need to install and configure Fcitx for Qt5 correctly before continue.

Then you need to copy the lib to Qt's plugin directory:

<path_to_Qt_installation_directory>/5.12.10/gcc_64/plugins/platforminputcontexts/

OpenSSL

After the installation of openSSL, you could find two lib files:

/usr/lib/libcrypto.so.1.0.0
/usr/lib/libssl.so.1.0.0

Copy these two files to Qt's library directory:

<path_to_Qt_installation_directory>/5.12.10/gcc_64/lib/

In Qt's library directory, create symlinks for these two files:

ln -s libcrypto.so.1.0.0 libcrypto.so
ln -s libssl.so.1.0.0 libssl.so

MacOS

If you prefer command line on macOS, you could follow these steps.

1. Install Xcode and Homebrew;

2. Install Qt 5.12.10 via Homebrew:

   brew install [email protected]
   

3. In the project directory, create build_macos.sh like this:

   QTDIR="/usr/local/opt/[email protected]"
   PATH="$QTDIR/bin:$PATH"
   LDFLAGS=-L$QTDIR/lib
   CPPFLAGS=-I$QTDIR/include
   
   mkdir -p build
   cd build
   qmake -v
   qmake CONFIG-=debug CONFIG+=release ../vnote.pro
   make -j2
   

4. Make build_macos.sh executable and run it:

   chmod +x build_macos.sh
   ./build_macos.sh
   

5. Now you got the bundle path/to/project/build/src/vnote.app.