Building
If you have corrections, additions, or updates to the instructions given below - or instructions for another distribution not covered yet -, please contact us (preferably on the mailing list or via email).
Building TeXworks on typical GNU/Linux systems is fairly straightforward. You just need standard build tools (gcc, make, cmake, etc.), and the development files (not just runtime libraries) for Qt, poppler, hunspell, and dbus. The exact set of packages needed will depend how your distribution arranges things; some examples are given here.
For Windows users wanting to try a build, see the page about installing and using the MinGW tools. Thanks to Alain Delmotte and Tomek for their help in researching, testing, and documenting the Windows build procedure.
For Mac users, see the pages
- building on macOS using Homebrew, Thanks to Charlie Sharpsteen for researching and documenting this macOS build procedure.
- building on macOS arm64, Thanks to Jérôme Laurens for researching and documenting this macOS build procedure.
If you not only want to build TeXworks, but also package it to share with others, have a look at the file PACKAGING in the source tree.
Note: The procedure below uses git clone to download the source code. This is the recommended procedure if you want to work on the source code or if you want to stay up to date with the latest changes of the code. If you only want to build TeXworks once, you can save bandwidth by downloading and unpacking the sources from GitHub.
sudo yum install cmake git make hunspell-devel lua-devel poppler-data poppler-qt5-devel qt5-qtbase-devel qt5-qtdeclarative-devel qt5-qtscript-devel qt5-qttools-static zlib-devel
git clone https://github.com/TeXworks/texworks.git
cd texworks
mkdir build
cd build
cmake ..
make
./texworks
sudo apt install cmake g++ git libhunspell-dev liblua5.3-dev libpoppler-qt5-dev libpoppler-private-dev make poppler-data qtbase5-dev qtdeclarative5-dev qtscript5-dev qttools5-dev qttools5-dev-tools zlib1g-dev
git clone https://github.com/TeXworks/texworks.git
cd texworks
mkdir build
cd build
cmake ..
make
./texworks
Another option is to use the Ubuntu package repository, thus avoiding the need to compile from source.
sudo zypper install cmake dbus-1-devel git hunspell-devel libpoppler-qt5-devel libqt5-qtbase-devel libqt5-qtdeclarative-devel libqt5-qtscript-devel libqt5-qttools-devel lua-devel make poppler-data zlib-devel
git clone https://github.com/TeXworks/texworks.git
cd texworks
mkdir build
cd build
cmake ..
make
./texworks
Adapted from a report by wtx358:
Install the following packages:
qt
hunspell
poppler
poppler-data
dbus
Then run
$ git clone https://github.com/TeXworks/texworks.git
$ cd texworks
mkdir build
cd build
cmake ..
make
./texworks