Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #410

Merged
merged 2 commits into from
Mar 14, 2021
Merged

Update docs #410

merged 2 commits into from
Mar 14, 2021

Conversation

yan12125
Copy link
Member

@yan12125 yan12125 commented Mar 3, 2021

@tsujan: I requested a review just as a reminder. This PR is in no hurry. Any time before 0.17 is fine.

* Minimal Qt version is bumped in lxqt/lxqt#1844
* Minimal CMake version is bumped in #230
* Closes #402 - confusion around lxqt-build-tools version and PyQt
  builds
@yan12125 yan12125 requested a review from tsujan March 3, 2021 12:24
Technically, the background image is no longer blended with the background color.

Before migrating the settings, the background image should be converted to a translucent one with the transparency level matching the original terminal transparency.
For example, if the original terminal transparency of qtermwidget was 25%, the converted image should have transparency 25%.
Copy link
Member

Choose a reason for hiding this comment

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

I think the above 2 lines may be a little confusing. For example, the terminal transparency can be zero but the user may prefer a very translucent background image. There's no predetermined relationship between image translucency and terminal transparency. It depends on the image and, of course, the user's taste.

Something like this may be better (only as a suggestion):

Any background image can be used but, of course, it should be chosen so that the terminal text can be easily read on it.

Since an image may not be totally dark or light, you might want to use a translucent image as the background. Opaque images can also be converted to translucent ones easily.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'd like to provide a clear migration path for the most common existing usage (I assume it is, as many other terminals work that way). How about appending my paragraph after yours as an example?

Copy link
Member

Choose a reason for hiding this comment

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

How about appending my paragraph after yours as an example?

That would be better.

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated, thanks a lot for the suggestion!

@tsujan
Copy link
Member

tsujan commented Mar 4, 2021

This may be totally unrelated to the current PR. It's just a suggestion about all future Markdown documents in LXQt.

I remember that @agaida told me about line length in plain-text and that it's better to be less than 80/90. 80 may be too small. So, if we want to limit the plain-text line length in our future Markdown docs — which is NOT necessary at all — we could use 90.

I don't want to cause headaches about such an unimportant topic. Feel free to ignore it if it's too much.

@yan12125
Copy link
Member Author

yan12125 commented Mar 5, 2021

The line length limit is a good idea. How about mentioning it at lxqt/pcmanfm-qt#550 or some other more visible ticket?

@tsujan
Copy link
Member

tsujan commented Mar 5, 2021

How about mentioning it at lxqt/pcmanfm-qt#550 or some other more visible ticket?

Yes, we should mention it somewhere.

90 was just a suggestion; some may prefer 100.

@yan12125
Copy link
Member Author

90 was just a suggestion; some may prefer 100.

I found 100 still short. I prefer to suggest against long sentences but not forbid them ;)

Copy link
Member

@tsujan tsujan left a comment

Choose a reason for hiding this comment

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

I think it's good.

@tsujan
Copy link
Member

tsujan commented Mar 13, 2021

I prefer to suggest against long sentences but not forbid them.

Agreed. We don't need a strict rule in this regard.

@yan12125
Copy link
Member Author

Thanks for the reviews! I'd like to merge it sooner - I'm afraid I forgot about it before the next release.

@yan12125 yan12125 merged commit 059d832 into master Mar 14, 2021
@yan12125 yan12125 deleted the docs branch March 14, 2021 08:55
inventor2525 pushed a commit to inventor2525/qtermwidget that referenced this pull request May 14, 2024
* Update docs

* Minimal Qt version is bumped in lxqt/lxqt#1844
* Minimal CMake version is bumped in lxqt#230
* Closes lxqt#402 - confusion around lxqt-build-tools version and PyQt
  builds

* Address comments
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.

lxqt-build-tools version "0.8.0" required for compilation?
2 participants