notgne2/tuxpaint-pencil-sharpener
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Starting out a TROUBLESHOOTING.txt doc

Browse source
This commit is contained in:
Bill Kendrick 2023-03-09 22:42:43 -08:00
parent b6b1942513
commit 41c9fd1718
2 changed files with 65 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

7
docs/CHANGES.txt
View file

@ -7,7 +7,7 @@ Various contributors (see below, and AUTHORS.txt)
https://tuxpaint.org/ https://tuxpaint.org/
2023.March.8 (0.9.29) 2023.March.9 (0.9.29)
* Improvements to "Stamp" tool: * Improvements to "Stamp" tool:
----------------------------- -----------------------------
* Stamps may now be rotated. * Stamps may now be rotated.
@ -376,6 +376,11 @@ https://tuxpaint.org/
* New "Quickstart Guide" document added. * New "Quickstart Guide" document added.
Bill Kendrick <bill@newbreedsoftware.com> Bill Kendrick <bill@newbreedsoftware.com>
* "Troubleshooting" document added (work-in-progress, and
mostly for developer use when getting info. from users
experiencing problems)
Bill Kendrick <bill@newbreedsoftware.com>
* Magic tool API documentation updated to match other docs, * Magic tool API documentation updated to match other docs,
and allow for localization. (Maintained in "tuxpaint-docs" repo.) and allow for localization. (Maintained in "tuxpaint-docs" repo.)
Bill Kendrick <bill@newbreedsoftware.com> Bill Kendrick <bill@newbreedsoftware.com>

59
docs/TROUBLESHOOTING.txt Normal file
View file

@ -0,0 +1,59 @@
Troubleshooting Guide for Tux Paint
Last updated: 2023.03.09
Questions
=========
For users, the following is a list of information you can send the
Tux Paint developers when opening a ticket at SourceForge.net or
emailing us for assistance.
Tux Paint project members, if someone has asked you for help, there is
information you can gather before passing it along to the developers
(in particular, those who help maintain the various ports of Tux Paint).
Windows
-------
* The version of Windows (e.g., "Windows 11 Pro 22H2")
* The version of Tux Paint (e.g., "0.9.28-3")
* Type of the package used -- Installer EXE or Portable ZIP version
* If Installer, Which installation type was selected while -- "All Users"
or "Current User Only"
* Send a copy of the config file, e.g. "tuxpaint.cfg" in
C:\Users\username\AppData\Roaming\TuxPaint\
* Send any debugging output files, e.g., "stdout.txt" and "stderr.txt"
in C:\Users\username\AppData\Roaming\TuxPaint\
* FIXME -- Anything else?
macOS
-----
* The version of macOS (e.g., "macOS 13.1 Ventura")
* The CPU type (e.g., "Intel x86_64", or "Apple Silicon M1")
* The version of Tux Paint (e.g., 0.9.28-3)
* Send a copy of the config file, e.g. "tuxpaint.cfg" in
$HOME/Library/Application Support/TuxPaint/
* FIXME -- Current way to grab stderr/stdout output
(may need to describe how to get the Terminal app?)
* FIXME -- Anything else?
Android
-------
* The version of Android (e.g., "Tiramisu (OS 13)")
* The version of Tux Paint (e.g., "0.9.28-1" aka "9281")
* The source of Tux Paint -- Google Play, F-Droid, direct APK download
* Any changes made to Tux Paint configuration ("gear" icon)
FIXME -- Is there an easy way to grab the config file?
* FIXME -- Anything else?
Linux
-----
* The Linux distro and version (e.g., Ubuntu 22.04, RHEL 9, etc.)
* The version of Tux Paint (e.g., "0.9.28-3")
* The source of Tux Paint -- built from source code, installed
from distro's software repository, direct package file download
(.rpm), Flatpak, etc.
* Send a copy of the config file, e.g. ".tuxpaintrc" in $HOME
* Any output seen on a terminal when running "tuxpaint" from
a command-line
* FIXME -- Anything else?