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.

Sign up for GitHub

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

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8b2a07e
Added a note to the README
cMancio00 May 30, 2024
7aff2ec
Added changes proposed by klmcwhirter. close #167
cMancio00 May 30, 2024
fa59b29
Removed the NOTE to protect the existing document style choices
cMancio00 May 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.


#### Cache file location

Expand Down Expand Up @@ -172,6 +172,8 @@ Show cache created by EnvyControl
sudo envycontrol --cache-query
```

>[!NOTE]
Copy link
Contributor

@klmcwhirter klmcwhirter May 30, 2024 •
edited
Loading

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.

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

## ⬇️ Getting EnvyControl

Expand Down