diff --git a/INSTALL.md b/INSTALL.md index ff8c120b..847c3223 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -196,13 +196,13 @@ it before starting this process. ### XQuartz -[XQuartz](https://www.xquartz.org/) is an X11 windows manager. If you don't -have it installed already, you can either download and install it manually -via the link _or_ install it with Homebrew using: - -``` -brew install --cask xquartz -``` +XQuartz is an X11 windows manager. If you don't have it installed already, you +can either: +* Download and install it manually from [xquartz.org](https://www.xquartz.org/) +* Install it with Homebrew using + ``` + brew install --cask xquartz + ``` After you install XQuartz, you must ***log out and back in*** to your account on your computer, or reboot, before Guiguts can use it as the X11 server. diff --git a/Makefile b/Makefile index 2c908adf..2efd2ed5 100644 --- a/Makefile +++ b/Makefile @@ -6,7 +6,7 @@ VERSION=1.6.0 ZIP=zip -rv9 # files to include from the root -INCLUDES=CHANGELOG.md INSTALL.md UPGRADE.md LICENSE.txt README.md THANKS.md +INCLUDES=CHANGELOG.md INSTALL.md UPGRADE.md LICENSE.txt README.md THANKS.md TROUBLESHOOTING.md TARGETS= generic win mac diff --git a/README.md b/README.md index 3ba7d2cf..8b5b1d4a 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,8 @@ If you are upgrading from an earlier version of Guiguts, see To install Guiguts see [INSTALL.md](INSTALL.md). +For troubleshooting tips, see [TROUBLESHOOTING.md](TROUBLESHOOTING.md). + ## Development ### Code style diff --git a/TROUBLESHOOTING.md b/TROUBLESHOOTING.md new file mode 100644 index 00000000..fe6e068f --- /dev/null +++ b/TROUBLESHOOTING.md @@ -0,0 +1,46 @@ +# Troubleshooting + +Here are some troubleshooting tips for getting Guiguts running. + +## macOS + +### Unable to start Guiguts + +If Guiguts shows errors connecting to the X11 server, try starting Guiguts +from within an X11 terminal instead of Terminal.app. To do this: + +1. Start XQuartz with Applications -> Utilities -> XQuartz +2. Open a terminal from the XQuartz menu with Applications -> Terminal +3. Within the xterm terminal, navigate to your Guiguts install directory +4. Start guiguts with `perl guiguts.pl` + +### Guiguts no longer runs after a macOS upgrade + +After upgrading macOS, either to a new release of an existing version or to +an entirely new version of the operating system, Guiguts may no longer start. +One thing to try is to reinstall and upgrade some of the Guiguts dependencies. +In Terminal.app, run: + +```bash +# uninstall and re-install the XCode CLI +sudo rm -rf /Library/Developer/CommandLineTools +sudo xcode-select --install + +# update homebrew and all packages, including perl +brew update +brew unpin perl +brew upgrade + +# re-pin perl +brew pin perl + +# re-install the Guiguts packages using install_cpan_modules.pl +# see INSTALL.md for more information on installing packages +perl install_cpan_modules.pl +``` + +If the above did not fix the problem, also upgrade XQuartz: +* If you installed XQuartz from homebrew, the steps above will have updated + it for you. +* If you installed XQuartz manually from [xquartz.org](https://www.xquartz.org/), + download and install the latest version.