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

Added a note to the README #169

Merged
merged 3 commits into from
May 31, 2024
Merged

Added a note to the README #169

merged 3 commits into from
May 31, 2024

Conversation

cMancio00
Copy link
Contributor

Added a clarification on the cache paragraph to Highlight that a reboot is still necessary.

This is for potatoes like me who believe they can switch from integrated to nvidia without having to reboot

Added a clarification on the chace paragraph to Highlight that a reboot is still necessary
@klmcwhirter
Copy link
Contributor

Can we just change the first line to add the sentence:

... possible. A reboot is required as usual so the changes can take effect.

Perhaps you could add a note after the Caching command line examples section headers along these lines to address the other thing you ran into.

Note that these are just helpers to accomodate maintenance tasks. The cache is created automatically whenever switching away from hybrid mode - to integrated or nvidia mode.

Sound good?

@cMancio00
Copy link
Contributor Author

@klmcwhirter Sound good, I will make another commit.

README.md Outdated
@@ -172,6 +172,8 @@ Show cache created by EnvyControl
sudo envycontrol --cache-query
```

>[!NOTE]
Copy link
Contributor

@klmcwhirter klmcwhirter May 30, 2024

Choose a reason for hiding this comment

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

Can we remove this special callout now - just the [!NOTE]? This is not done anywhere else in the README.
I do not feel really strongly about this comment. Just trying to protect the existing document style choices. I can be easily swayed to keep it if you feel it is really needed.

And can this be moved right under the section header - after the blank line in line 131?

@bayasdev can you weigh in here please?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, we can remove the [!NOTE] to stick with the document style, however I would also make the note as a standard paragraph after the blank line in line 131.

@@ -125,7 +125,7 @@ sudo envycontrol --reset
```

### Caching added with 3.4.0
A cache was added in version 3.4.0. The main purpose is to cache the Nvidia PCI bus ID so that a transition from integrated mode directly to nvidia mode is possible.
A cache was added in version 3.4.0. The main purpose is to cache the Nvidia PCI bus ID so that a transition from integrated mode directly to nvidia mode is possible. A reboot is required as usual so the changes can take effect.
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for making this change. This feels more concise now.

Copy link
Owner

@bayasdev bayasdev left a comment

Choose a reason for hiding this comment

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

LGTM

@bayasdev bayasdev merged commit 8bab863 into bayasdev:main May 31, 2024
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.

3 participants