hluk/CopyQ

Documentation: The Basics―First Start assumes desktop icon and Unix

Open

#3354 opened on Dec 16, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (7,372 stars) (419 forks)batch import
Windowsbughelp wanted

Description

The documentation's The Basics chapter contains a Basic Usage section. Its First Start subsection starts with:

To start CopyQ, double-click the program icon or run command copyq. This starts the graphical interface which can be accessed from the tray (NOTE: on OS X the tray defaults to the top-right of the screen and is not to be confused with Launchpad).

This will be at least confusing to users of Microsoft Windows, since on that OS, the command needed would have to use an absolute or relative path, and refer to the CopyQ.exe binary. Moreover, at least on Windows, no desktop icon is created by default.

A more typical way to start CopyQ would be to launch it from the Start menu. However, I believe CopyQ 13 is launched by default, so this may not be necessary.

The README's Using the App section has the same issue.

Contributor guide

Tech stack
cpp
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic markdown knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Update the documentation in basic usage.html and README.md to address differences for Windows and macOS. For Windows, note that CopyQ is started from the Start menu and no desktop icon is created by default, and explain the command path. For macOS, update 'OS X' to 'macOS'. There are no comments or PRs to refer to.