Sigil

Sigil is a free, open source, multi-platform ebook editor that uses Qt (and QtWebEngine). It is designed to edit books in ePub format (both ePub 2 and ePub 3).

Issue Tracker

Please do not use the issue tracker to ask questions or suggest new features. Both of the main developers of Sigil monitor the Sigil Forum at https://www.mobileread.com/forums. All questions and feature requests should be directed there so that other interested users can help or comment.

Issue tracking is intended for discussion around issues with the code. It is also intended for actual bug tracking.

Feature requests opened on the issue tracker will be closed.

Linux Build and Install

For newer Linux systems like Ubuntu 20.04 (and its derivitives: like Mint 20), or Arch Linux, or Debian Unstable, you should be able to compile Sigil using repo-provided dependencies. Instructions for doing so can be found in:

docs/Building_on_Linux.md (or .html)

For older Linux systems whose software repositories do not provide Qt5.10.0 (or higher), the detailed instructions for building/installing Sigil can be found in:

docs/Building_on_older_Linux.md (or .html)

An up-to-date version of Sigil is available via flatpak on Flathub. So if your distro can use Flatpak, you can always use Sigil that way if your distro's Sigil package seems to be lagging too far behind.

For Building on Mac OS X

Building using purely XCode is no longer supported on Mac OS X. The easiest way to build Sigil on Mac OS X is to use cmake 3.X and the command line.

Also because Sigil now embeds Python 3.11.3, see

docs/Building_A_Relocatable_Python_3.11_Framework_on_MacOSX.txt

for detailed instructions on how to build a fully relocatable Python 3.11.3 framework before building Sigil.

For official releases Sigil uses Qt-5.15.9 plus local patches see

docs/Building_Qt5_From_Source_on_MacOSX.txt

Sigil master now supports building with Qt-5.10.X through to Qt-6.5.0. For Qt6 see

docs/Building_Qt6_From_Source_on_MacOSX.txt

Due to not owning a MacOS M1 (arm64) machine for development, we do not (yet) make MacOS arm64 based release builds. But, building Sigil from source on MacOS M1 (arm64) machines using recent Python and versions does work.

And finally to build Sigil itself see:

docs/Building_Sigil_On_MacOSX.txt

and for building Sigil under Qt6 see:

docs/Building_Sigil_On_MacOSX_With_QT6.txt

For Installing/Building on Windows

Sigil currently provides Windows installers for x86 and x64 and will only work on Windows 8 or newer. There's a Legacy installer that's suitable for Windows 7.

The latest Sigil versions are also typically available via the winget (Windows 10+), Chocolatey (Windows 7+), and Npackd Windows package managers. There are no "scary" Microsoft warnings about unknown publishers if you install Sigil via one of these package managers.

To build Sigil on Windows yourself, see:

docs/Building_Sigil_on_Windows.md (or .html)

License

Sigil is licensed under the GPLv3. The complete license is located in COPYING.txt.

Note that libraries and components Sigil used and bundles may use a different license (that is compatible with the GPLv3) from Sigil. See the specific component for their respective license. The source code from these projects can be found under Sigil/3rdparty unless otherwise indicated.
Please see their respective folders for complete license information.

Currently these projects include:

Hunspell 1.7.2 - https://github.com/hunspell/hunspell
MiniZip version 1.1 (plus some security changes)
Perl-compatible Regular Expression Library 2 (pcre2 version 10.39)
ZLib Data Compression Library (zlib 1.2.13)
jQuery-3.6.4 (src/Resource_Files/javascript/jquery-3.6.4.min.js)
jQuery.ScrollTo-2.1.2 (src/Resource_Files/javascript/jquery.scrollTo-2.1.2.min.js)
MathJax.js Version 3.2.X [required minimum is 3.2.2]: (src/Resource_Files/polyfills)

In addtion, Sigil uses the following other packages that have been specifically modified for use inside Sigil: