Skip to content

Update install instructions - #1937

Open
windymilla wants to merge 2 commits into
DistributedProofreaders:masterfrom
windymilla:install-docs
Open

Update install instructions#1937
windymilla wants to merge 2 commits into
DistributedProofreaders:masterfrom
windymilla:install-docs

Conversation

@windymilla

Copy link
Copy Markdown
Collaborator

Windows Python install uses Install Manager now.
MacOS users can use Automator to create an app.

@srjfoo - Please check changes, especially suggested alternative for Automator script which states the path in the python command, rather than exporting an updated PATH variable. If it works OK, it seems simpler for users. Thanks.
I also left a [**...] note in point 1 of the macOS user install, about the PATH. Do we need to tell the user how to add to the PATH, and if so, what should we say?

Windows Python install uses Install Manager now.
MacOS users can use Automator to create an app.
@windymilla
windymilla requested a review from srjfoo August 21, 2026 12:50

@tangledhelix tangledhelix left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some suggestions, will let @windymilla and/or @srjfoo decide whether to make them or leave as-is...

Comment thread README.md Outdated

2. In a terminal window, type `pip3 install guiguts` (or `pip3 install guiguts --upgrade` to upgrade from a
previous version of GG2).
previous version of GG2). If you cannot use `pip3`, try `python3 -m pip install guiguts` instead.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The second variant should work either way; we could simplify the instructions by omitting pip3 mention entirely?

Comment thread README.md Outdated
previous version of GG2). If you cannot use `pip3`, try `python3 -m pip install guiguts` instead.

3. In a terminal window, type `guiguts` to run GG2.
3. In a terminal window, type `guiguts` to run GG2. If this does not work, due to not being on your PATH,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, the second variant should work always, even if the first won't (and it seems the Python installers have shifted something so maybe it will become more common that just guiguts won't work reliably). We could simplify the instructions by only giving one suggestion.

@windymilla

Copy link
Copy Markdown
Collaborator Author

Fixes #1933

@windymilla windymilla linked an issue Aug 22, 2026 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Possible updates to install information

2 participants