Skip to content

Rewrote prerequisites section in README.md#6422

Open
Wallby wants to merge 3 commits into
fyne-io:developfrom
Wallby:develop
Open

Rewrote prerequisites section in README.md#6422
Wallby wants to merge 3 commits into
fyne-io:developfrom
Wallby:develop

Conversation

@Wallby

@Wallby Wallby commented Jul 17, 2026

Copy link
Copy Markdown

Description:

Fixes #6418

Checklist:

None relevant.

  • [ ] Tests included.
  • [ ] Lint and formatter run with no errors.
  • [ ] Tests all pass.

Comment thread README.md Outdated
Comment on lines +29 to +34
Before running this second command, there must be a reference to fyne in one of your project's source files. The following, works:

import "fyne.io/fyne/v2/app"

Note that:
* `import "fyne.io/fyne/v2"` does not work.

@Wallby Wallby Jul 19, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Perhaps the intended design of the individual fyne modules should be better explored. Mentioning @andydotxyz related to this comment #6418 (comment).

If the intended design is clearer, then this section could be rewritten before merging the pull request. Such that it is better defined whether the above is a workaround that works now, or defined behaviour that will continue to work always.

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.

This is going far too much into the weeds - which packages can and cannot retain a go.mod reference with no code added is unimportant - what matters is the app using fyne before they call "go mod tidy"

@andydotxyz andydotxyz 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.

I think this is getting caught up on details that don't matter by explaining tools that the user may not be using. A clearer definition of Fyne package requirements will cause more confusion not les.

Comment thread README.md Outdated
Comment on lines +29 to +34
Before running this second command, there must be a reference to fyne in one of your project's source files. The following, works:

import "fyne.io/fyne/v2/app"

Note that:
* `import "fyne.io/fyne/v2"` does not work.

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.

This is going far too much into the weeds - which packages can and cannot retain a go.mod reference with no code added is unimportant - what matters is the app using fyne before they call "go mod tidy"

Comment thread README.md Outdated

Note that:
* `import "fyne.io/fyne/v2"` does not work.
* some tools (such as [the official Visual Studio Go extension](https://marketplace.visualstudio.com/items?itemName=golang.go)), automatically remove unused imports. In which case you'll have to also write some code that uses an imported fyne module.

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.

Don't go into the details - just phrase it such that the code should use some Fyne code before calling "go mod tidy" to be ready to build.

@Wallby

Wallby commented Jul 20, 2026

Copy link
Copy Markdown
Author

@andydotxyz I addressed the feedback, how is this?

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.

Rephrase getting started section

2 participants