Compilling and Installing OBK from develop branch

[codayon]

Dependencies

• CMake
• Fcitx 5
• Git
• GNU GCC or Clang
• GNU Make or Ninja
• Qt 5.5 or later
• Rust 1.63.0 or later
• Zstandard (zstd)

Note

A few package names are borrowed from asifakonjee/openbangla-script repository.

# Pick one and run the command for your system:

# Arch Linux (pacman)
sudo pacman -S --needed cmake fcitx5 fcitx5-configtool fcitx5-qt fcitx5-gtk git base-devel qt5-base zstd

# Debian (apt)
sudo apt install build-essential cmake qtbase5-dev qtbase5-dev-tools libzstd-dev libfcitx5core-dev fcitx5 fcitx5-config-qt pkg-config libibus-1.0-dev git

# Fedora (dnf)
sudo dnf install @development-tools cmake qt5-qtdeclarative-devel libzstd-devel fcitx5 fcitx5-configtool fcitx5-devel fcitx5-qt5 git

# macOS (brew)
brew install qt@5 zstd

# openSUSE (zypper)
sudo zypper in libQt5Core-devel libQt5Widgets-devel libQt5Network-devel libzstd-devel libzstd1 cmake make ninja clang gcc patterns-devel-base-devel_basis git fcitx5-devel fcitx5 fcitx5-configtool

# Void Linux (xbps)
sudo xbps-install base-devel make cmake qt5-declarative-devel libzstd-devel qt5-devel git fcitx5 libfcitx5-devel fcitx5-configtool

Install Rust and Cargo through rustup

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Compiling and Installing

# Clone the repository and navigate into the project folder
git clone --recursive https://github.com/OpenBangla/OpenBangla-Keyboard.git
cd OpenBangla-Keyboard

# Switch to the develop branch and update submodules
git checkout develop && git submodule update

# Create a build directory 
mkdir build && cd build

Configure CMake

For Linux (IBus / Fcitx):

# Available build options:

# Build with both IBus and Fcitx support
# -DENABLE_BOTH=ON

# Build with IBus support only
# -DENABLE_IBUS=ON

# Build with Fcitx support only
# -DENABLE_FCITX=ON

cmake -DENABLE_BOTH=ON -DCMAKE_INSTALL_PREFIX="/usr" ..

For macOS (Apple Silicon):

cmake -DCMAKE_PREFIX_PATH=/opt/homebrew/opt/qt@5 ..

For macOS (Intel):

cmake -DCMAKE_PREFIX_PATH=/usr/local/opt/qt@5 ..

Build and Install

For Linux:

make
sudo make install

For macOS:

make

Finally

After installing OpenBangla Keyboard, log out and back in (or restart your system), then configure your desktop environment.

[azrtareef]

im getting this error when im trying to configure cmake:

build
~> cmake .. -DENABLE_IBUS=OFF -DENABLE_FCITX=ON -DCMAKE_INSTALL_PREFIX="/usr"                                                                                                   on (󰘬 master)
-- The C compiler identification is GNU 16.1.1
-- The CXX compiler identification is GNU 16.1.1
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working C compiler: /usr/bin/cc - skipped
-- Detecting C compile features
-- Detecting C compile features - done
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Check for working CXX compiler: /usr/bin/c++ - skipped
-- Detecting CXX compile features
-- Detecting CXX compile features - done
CMake Error at CMakeLists.txt:14 (enable_language):
  Experimental Rust support is not enabled.


CMake Error: CMAKE_Rust_COMPILER not set, after EnableLanguage
-- Configuring incomplete, errors occurred!
build

using the obk script somehow fixes that

[codayon]

CMake Error at CMakeLists.txt:14 (enable_language):
Experimental Rust support is not enabled.

CMake Error: CMAKE_Rust_COMPILER not set, after EnableLanguage
-- Configuring incomplete, errors occurred!

You have probably missed a step where we checkout develop branch and update the submodules.

git checkout develop && git submodule update

The line 14 of CMakeLists.txt does not enable Rust.

It only exists in the master branch and in branches where this #465 isn't synced yet.

If I remember correctly, I was able to compile following these steps on a Arch based system a month ago.

[codayon]

Yes, it still works as expected.

Click here to expand

~/documents/OpenBangla-Keyboard/build develop
❯ cmake .. -DENABLE_IBUS=OFF -DENABLE_FCITX=ON -DCMAKE_INSTALL_PREFIX="/usr"
-- The C compiler identification is GNU 16.1.1
-- The CXX compiler identification is GNU 16.1.1
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working C compiler: /usr/bin/cc - skipped
-- Detecting C compile features
-- Detecting C compile features - done
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Check for working CXX compiler: /usr/bin/c++ - skipped
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Rust Target: x86_64-unknown-linux-gnu
-- Determining required link libraries for target x86_64-unknown-linux-gnu
-- Required static libs for target x86_64-unknown-linux-gnu: gcc_s;util;rt;pthread;m;dl;c
-- Required link flags for target x86_64-unknown-linux-gnu: 
-- Found Rust: /usr/bin/rustc (found version "1.96.0")
-- Qt5 framework version: 5.15.19
-- Found PkgConfig: /usr/bin/pkg-config (found version "2.5.1")
-- Installing in the same prefix as Fcitx, adopting their path scheme by default
-- Checking for module 'libzstd'
--   Found libzstd, version 1.5.7
-- Looking for pthread_create
-- Looking for pthread_create - found
-- Found Pthread: /usr/include
-- Looking for dlmopen
-- Looking for dlmopen - found
-- Found DL: /usr/include
-- Configuring done (1.2s)
-- Generating done (0.1s)
-- Build files have been written to: /home/user/documents/OpenBangla-Keyboard/build