README

This is the source tree for the AbiSource desktop productivity tools,
namely the AbiWord word processor.
Everything contained here is copyrighted and is available for your use
and redistribution under certain license terms.  Please read
COPYRIGHT.TXT and TRADEMARK.TXT for more information.

Current information is available at https://www.abisource.com/.

This tree contains the following top-level subdirectories:

src
	All source code is under here, including applications,
	library modules, and third-party source code.

ac-helpers
	Autoconf macros used by the autoconfiscated build system (configure).

docs
	Documents related to the project.  Includes specifications,
	design documents, and the like.  You should also find instructions
	for how to build the tree in here, within the "build" subdirectory.

po
	Localized strings for each locale we support, in PO format, as well
	as scripts for conversion to and from Abi's native .strings files,
	which are the files actually used directly by the program(s).  PO
	files are maintained as a convenience for translators, many of whom
	are already accustomed to working with them (as opposed to .strings).

test
	Test files for AbiWord (not explicitly part of regression testing).

user
	Support files, other than code, which need to be installed
	on the user's machine, are stored in here.  Items which
	are too large to be practical do not necessarily go here,
	such as the fonts.

flatpak
        Files to build AbiWord as a flatpak using flatpak-builder. See
        instructions below.

Flatpak
=======

We support flatpak:

To build:

$ flatpak-builder --force-clean --repo=repo abiword flatpak/com.abisource.AbiWord.json

To run:

$ flatpak-builder --run abiword flatpak/com.abisource.AbiWord.json abiword