Sync docs: INSTALL update re: SDL2.0

This commit is contained in:
Bill Kendrick 2022-09-23 21:20:07 -07:00
parent 9bd32905e2
commit f2674920c8
10 changed files with 194 additions and 274 deletions

View file

@ -5,7 +5,7 @@
Copyright © 2002-2022 by various contributors; see AUTHORS.txt.
https://tuxpaint.org/
July 10, 2022
September 23, 2022
+----------------------------------------------------+
|Table of Contents |
@ -34,33 +34,28 @@ Simple DirectMedia Layer library (libSDL)
Along with libSDL, Tux Paint depends on a number of other SDL 'helper'
libraries: SDL_Image (for graphics files), SDL_gfx (for some graphical
functions, like rotation), SDL_TTF and (optionally) SDL_Pango (for True
functions, like rotation), SDL_TTF and (optionally) SDL2_Pango (for True
Type Font support) and, optionally, SDL_Mixer (for sound effects).
Linux/Unix
The SDL libraries are available as source-code, or as RPM or Debian
packages for various distributions of Linux. They can be downloaded from:
The SDL libraries are available as source-code, or as RPM or
Debian packages for various distributions of Linux. They can be
downloaded from:
* libSDL: http://www.libsdl.org/
* SDL_image: https://github.com/libsdl-org/SDL_image
* SDL_gfx:
https://www.ferzkopp.net/wordpress/2016/01/02/sdl_gfx-sdl2_gfx/
(https://sourceforge.net/projects/sdlgfx/)
* SDL_ttf: https://github.com/libsdl-org/SDL_ttf
* SDL2_Pango: https://github.com/markuskimius/SDL2_Pango (optional)
* SDL_mixer: https://github.com/libsdl-org/SDL_mixer (optional)
* libSDL: http://www.libsdl.org/
* SDL_Image: http://www.libsdl.org/projects/SDL_image/
* SDL_gfx:
https://www.ferzkopp.net/wordpress/2016/01/02/sdl_gfx-sdl2_gfx/
(https://sourceforge.net/projects/sdlgfx/)
* SDL_TTF: http://www.libsdl.org/projects/SDL_ttf/
* SDL_Pango: http://sourceforge.net/projects/sdlpango/
(optional)
* SDL_Mixer: http://www.libsdl.org/projects/SDL_mixer/
(optional)
They are also typically available along with your Linux distribution (e.g.
on an installation media, or available via package maintainance software
like Debian's "apt").
They are also typically available along with your Linux
distribution (e.g. on an installation media, or available via
package maintainance software like Debian's "apt").
💡 Note: When installing libraries from packages, be sure to ALSO
install the development versions of the packages. (For example,
install both "SDL-1.2.4.rpm" and "SDL-1.2.4-devel.rpm".)
💡 Note: When installing libraries from packages, be sure to ALSO install
the development versions of the packages. (For example, install both
"SDL2-2.24.0.rpm" and "SDL2-devel-2.24.0.rpm".)
Other Libraries
@ -152,9 +147,6 @@ Windows
includes support for building on a Windows system using MinGW/MSYS
(https://sourceforge.net/projects/msys2/).
💡 Note: This documentation relates to the SDL2.0 version of Tux Paint,
which became available starting with version 0.9.28 in June 2022.
Many tools and libraries are required to build Tux Paint. The package
management system "pacman" helps you install them automatically solving
complicated dependencies.

View file

@ -96,7 +96,7 @@
</p>
<p>
July 10, 2022 </p>
September 23, 2022 </p>
</center>
</header>
@ -149,29 +149,24 @@
Tux Paint requires the Simple DirectMedia Layer Library (libSDL), an Open Source multimedia programming library available under the GNU Lesser General Public License (LGPL). </p>
<p>
Along with libSDL, Tux Paint depends on a number of other SDL 'helper' libraries: SDL_Image (for graphics files), SDL_gfx (for some graphical functions, like rotation), SDL_TTF and (optionally) SDL_Pango (for True Type Font support) and, optionally, SDL_Mixer (for sound effects). </p>
Along with libSDL, Tux Paint depends on a number of other SDL 'helper' libraries: SDL_Image (for graphics files), SDL_gfx (for some graphical functions, like rotation), SDL_TTF and (optionally) SDL2_Pango (for True Type Font support) and, optionally, SDL_Mixer (for sound effects). </p>
<dl>
<dt><strong>Linux/Unix</strong></dt>
<dd>
<p>
The SDL libraries are available as source-code, or as RPM or Debian packages for various distributions of Linux. They can be downloaded from: </p>
<ul>
<li>libSDL: <a href="http://www.libsdl.org/">http://www.libsdl.org/</a></li>
<li>SDL_Image: <a href="http://www.libsdl.org/projects/SDL_image/">http://www.libsdl.org/projects/SDL_image/</a></li>
<li>SDL_gfx: <a href="https://www.ferzkopp.net/wordpress/2016/01/02/sdl_gfx-sdl2_gfx/">https://www.ferzkopp.net/wordpress/2016/01/02/sdl_gfx-sdl2_gfx/</a> (<a href="https://sourceforge.net/projects/sdlgfx/">https://sourceforge.net/projects/sdlgfx/</a>)</li>
<li>SDL_TTF: <a href="http://www.libsdl.org/projects/SDL_ttf/">http://www.libsdl.org/projects/SDL_ttf/</a></li>
<li>SDL_Pango: <a href="http://sourceforge.net/projects/sdlpango/">http://sourceforge.net/projects/sdlpango/</a> (optional)</li>
<li>SDL_Mixer: <a href="http://www.libsdl.org/projects/SDL_mixer/">http://www.libsdl.org/projects/SDL_mixer/</a> (optional)</li>
</ul>
<p>
The SDL libraries are available as source-code, or as RPM or Debian packages for various distributions of Linux. They can be downloaded from: </p>
<ul>
<li>libSDL: <a href="http://www.libsdl.org/">http://www.libsdl.org/</a></li>
<li>SDL_image: <a href="https://github.com/libsdl-org/SDL_image">https://github.com/libsdl-org/SDL_image</a></li>
<li>SDL_gfx: <a href="https://www.ferzkopp.net/wordpress/2016/01/02/sdl_gfx-sdl2_gfx/">https://www.ferzkopp.net/wordpress/2016/01/02/sdl_gfx-sdl2_gfx/</a> (<a href="https://sourceforge.net/projects/sdlgfx/">https://sourceforge.net/projects/sdlgfx/</a>)</li>
<li>SDL_ttf: <a href="https://github.com/libsdl-org/SDL_ttf">https://github.com/libsdl-org/SDL_ttf</a></li>
<li>SDL2_Pango: <a href="https://github.com/markuskimius/SDL2_Pango">https://github.com/markuskimius/SDL2_Pango</a> (optional)</li>
<li>SDL_mixer: <a href="https://github.com/libsdl-org/SDL_mixer">https://github.com/libsdl-org/SDL_mixer</a> (optional)</li>
</ul>
<p>
They are also typically available along with your Linux distribution (e.g. on an installation media, or available via package maintainance software like Debian's "<code>apt</code>"). </p>
<p>
They are also typically available along with your Linux distribution (e.g. on an installation media, or available via package maintainance software like Debian's "<code>apt</code>"). </p>
<p class="note">
<span title="Information">&#128161;</span> <strong>Note:</strong> When installing libraries from packages, be sure to ALSO install the development versions of the packages. (For example, install both "<code>SDL-1.2.4.rpm</code>" <em>and</em> "<code>SDL-1.2.4-devel.rpm</code>".) </p>
</dd>
</dl>
<p class="note">
<span title="Information">&#128161;</span> <strong>Note:</strong> When installing libraries from packages, be sure to ALSO install the development versions of the packages. (For example, install both "<code>SDL2-2.24.0.rpm</code>" <em>and</em> "<code>SDL2-devel-2.24.0.rpm</code>".) </p>
</section><!-- H2: Simple DirectMedia Layer library (libSDL) -->
<section class="indent"><!-- H2: Other Libraries -->
@ -314,9 +309,6 @@
<p>
As of February 2005 (starting with Tux Paint 0.9.15), the "<code>Makefile</code>" includes support for building on a Windows system using MinGW/MSYS (<a href="https://sourceforge.net/projects/msys2/">https://sourceforge.net/projects/msys2/</a>). </p>
<p class="note">
<span title="Information">&#128161;</span> <strong>Note:</strong> This documentation relates to the SDL2.0 version of Tux Paint, which became available starting with version 0.9.28 in June 2022. </p>
<p>
Many tools and libraries are required to build Tux Paint. The package management system "<code>pacman</code>" helps you install them automatically solving complicated dependencies. </p>
@ -399,7 +391,7 @@
<span title="Information">&#128161;</span> <strong>Note:</strong> Close the shell before proceeding to the remaining process. </p>
</section><!-- H4: ...dependency libraries for Tux Paint -->
<section class="indent"><!-- H4: Install SDL_Pango... -->
<section class="indent"><!-- H4: Install SDL2_Pango... -->
<header>
<h4>
Install SDL2_Pango and libunibreak on the 64bit environment </h4>
@ -449,7 +441,7 @@
Proceed to the next "<a href="#32bit">MinGW 32bit (i686) toolchains</a>" section, or skip to the "<a href="#imagemagick">ImageMagick</a>" section if you need only a 64bit build environment. </i>
</p>
</section><!-- H4: Install SDL_Pango... -->
</section><!-- H4: Install SDL2_Pango... -->
<hr size="1" noshade width="75%" />
<section class="indent"><!-- H4: MinGW...compiler and tools -->
@ -493,7 +485,7 @@
<span title="Information">&#128161;</span> <strong>Note:</strong> Close the shell before proceeding to the remaining process. </p>
</section><!-- H4: ...dependency libraries for Tux Paint -->
<section class="indent"><!-- H4: Install SDL_Pango... -->
<section class="indent"><!-- H4: Install SDL2_Pango... -->
<header>
<h4>
Install SDL2_Pango and libunibreak on the 32bit environment </h4>
@ -539,7 +531,7 @@
</section><!-- H5: libunibreak -->
</section><!-- H4: Install SDL_Pango... -->
</section><!-- H4: Install SDL2_Pango... -->
</section><!-- H3: Compiling Set-Up -->