Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Main codebase
C++ HTML C CMake JavaScript TeX Other
Failed to load latest commit information.
CMake Migrate download of manual to GitHub release
lib-patches Update Homebrew build script for Poppler
man Update copyrights
modules/QtPDF Update references from README to README.md
plugins-src Merge pull request #698 from UniqMartin/general-stuff
res Warn when using UTF-8 with a BOM and a "Missing \begin{document}" err…
src Merge pull request #698 from UniqMartin/general-stuff
testcases Fix libpng1.6 iCCP/sRGB issues in pngs (issue 667)
trans Ensure 'trans/TeXworks_trans.pro' is always sorted
win32 Fix Inno Setup installation of manuals
.gitattributes Ignore .git* files when exporting the archive with `git archive`
.gitignore Improve, extend, and comment '.gitignore'
.mailmap Add .mailmap file for better author identification after migrating fr…
CMakeLists.txt Remove bogus flags from module linker flags
COPYING add copyright notice to source files
GitArchiveInfo.txt Fix quotes in GitArchiveInfo.txt
NEWS Fix year in NEWS file
PACKAGING Update README.md and PACKAGING to CMake and new URLs
README.md Update README.md and PACKAGING to CMake and new URLs
TeXworks-doc.icns icon update
TeXworks.icns icon update
TeXworks.plist.in Update copyrights
getDefaultBinPaths.sh Update default binary paths
getGitRevInfo.bat Make sure only the current .git directory is picked up by getGitRevInfo
getGitRevInfo.sh Make sure only the current .git directory is picked up by getGitRevInfo
texworks.appdata.xml Provide texworks.appdata.xml for *nix platforms (issue 657)
texworks.desktop Update translations (fr, zh_cn)
updateCopyrights.py Improve updateCopyrights.py
updateSyncTeX.sh Add script to auto-update SyncTeX (and update SyncTeX)

README.md

About TeXworks

TeXworks is an environment for authoring TeX (LaTeX, ConTeXt, etc) documents, with a Unicode-based, TeX-aware editor, integrated PDF viewer, and a clean, simple interface accessible to casual and non-technical users.

TeXworks is inspired by Dick Koch's award-winning TeXShop program for Mac OS X, which has made quality typesetting through TeX accessible to a wider community of users, without a technical or intimidating face. The goal of TeXworks is to deliver a similarly integrated, easy-to-use environment for users on other platforms, especially GNU/Linux and Windows.

Further Information

If you find any bugs/problems or have any recommendations, don't hesitate to stop by the development webpage, send a mail to the mailing list (preferably via the "Help > Email to mailing list" menu item which automatically includes some debug information), or file a bug report.

License

TeXworks is copyright (C) 2007-2015 by Jonathan Kew, Stefan Löffler, and Charlie Sharpsteen. Distributed under the terms of the GNU General Public License, version 2 or (at your option) any later version. See the file COPYING for details.

The SyncTeX code is copyright (c) 2008-2011 by Jérôme Laurens; see src/synctex_parser.c for license details.

Building TeXworks

Notes by Jonathan Kew, updated 2011-03-20 and 2015-03-29 by Stefan Löffler

To build TeXworks from source, you will need to install developer packages (or equivalent) for:

  • Qt4 (4.5.2 or later is recommended, although the application may build with versions as old as 4.3.x. Note that on GNU/Linux, TeXworks may crash when changing the spell-checking language when using Qt 4.3.x. Updating to at least Qt 4.4.0 solves this.)
    http://www.qt.io/download/

  • Poppler (using the latest stable release, currently 0.16, is strongly recommended, although versions as old as the 0.6 series should still work)
    http://poppler.freedesktop.org/

  • Hunspell (release 1.2.8 or later is recommended; earlier 1.2.x releases may be used, although support for some non-Latin-script languages may be lacking)
    http://hunspell.sourceforge.net/

along with their dependencies (such as Freetype, fontconfig, zlib, etc.) If you also want to build the scripting plugins (optional), you additionally need development packages for Lua and/or Python. Details will depend on your platform. On Linux or similar systems, your package manager can probably provide all these.

Once everything is set up, create a folder for building (e.g., "build") and run CMake in it to create a Makefile or Xcode project. Finally, run make or use Xcode to build the application.

The current TeXworks prototype has been successfully built with

  • Xcode (using gcc 4) on Mac OS X (built on 10.5, but should run on 10.4 or later)
  • MinGW release 5.1.4 on Windows XP (also runs on Vista and Windows 7)
  • gcc 4 on GNU/Linux, various BSDs, etc.

On the Mac, required libraries can be obtained, e.g., using Homebrew.

Further tips on building TeXworks from source are available on some of the wiki pages:

Something went wrong with that request. Please try again.