**********************************************
  AzPainter for Linux
  Copyright (C) 2013-2023 Azel

  http://azsky2.html.xdomain.jp/
  https://gitlab.com/azelpg/azpainter
  <azelpg@gmail.com>
**********************************************

This software is released under the GPL3 License.
Please see the file COPYING for details.


=====================================
 * Overview
=====================================

Paint software for editing illustrations and images.


=====================================
 * Operating environment
=====================================

- Linux, macOS(need XQuartz) others

- X11R6 or later


=====================================
 * What you need to compile
=====================================

- C compiler
- ninja (build tool)
- pkg-config
- development files for various libraries:
  x11 xext xcursor xinput
  zlib libpng jpeglib(jpeg-turbo) tiff webp fontconfig freetype2
  other than Linux: libiconv


--- Required packages  ---

(Debian/Ubuntu)

  gcc or clang, ninja-build pkg-config
  libx11-dev libxext-dev libxcursor-dev libxi-dev
  libfreetype6-dev libfontconfig1-dev
  zlib1g-dev libpng-dev libjpeg-dev libtiff-dev libwebp-dev

(RedHat)

  gcc or clang, ninja-build pkg-config
  libX11-devel libXext-devel libXcursor-devel libXi-devel
  libfreetype6-devel libfontconfig-devel
  zlib-devel libpng-devel libjpeg-devel libtiff-devel libwebp-devel

(Arch Linux)

  gcc or clang, ninja pkgconf
  libx11 libxext libxcursor libxi freetype2 fontconfig
  zlib libpng libjpeg-turbo libtiff libwebp
  
(macOS)

  xcode ninja pkg-config libpng jpeg-turbo libtiff webp

  [*] It is assumed that XQuartz is installed.


=====================================
 * Compile and install
=====================================

After extracting the archive, go to the extracted directory and do the following.

$ ./configure
$ cd build
$ ninja
# ninja install


- By default, it will be installed under "/usr/local".
- You can get help with $ ./configure --help.

## Install in /usr
$ ./configure --prefix=/usr

## Uninstall (build/)
# ninja uninstall

## Generate files for package file (build/)
$ DESTDIR=<DIR> ninja install


=====================================
 * Files
=====================================

INSTDIR is "/usr/local" by default.

<< Files to be installed >>

<INSTDIR>/bin/azpainter : Executable file
<INSTDIR>/share
  |- azpainter3/ : Files used by the app
  |- doc/azpainter/ : Document file
  |- applications/
     |- azpainter.desktop : Desktop file
  |- icons/hicolor/ : Icon file
     |- 48x48/apps/azpainter.png
     |- scalable/apps/azpainter.svg


<< File to be created >>

A "~/.config/azpainter" directory will be created
where each configuration file will be saved.


=====================================
 * How to use
=====================================

Shortcut to the "graphics" category of the main menu of the desktop
has been created, you can start from there.

If you want to start from the terminal, you can start with the following command.

$ azpainter


=====================================
 * About mlk
=====================================

I am using my own library mlk to build the GUI.

GUI fonts, colors, icon themes, etc. can be specified in the "az-mlk-style.conf" configuration file.

See "about_mlk_*.txt" for more information.

