Improve README.md #72
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AkihiroSuda
reviewed
Nov 19, 2024
README.md
Outdated
| - `/opt/socket_vmnet/bin/socket_vmnet` | ||
| - `/opt/socket_vmnet/bin/socket_vmnet_client` | ||
|
|
||
| You can customize the install location using the `PREFIX` environmemnt variable, |
There was a problem hiding this comment.
The default PREFIX has to be explained
There was a problem hiding this comment.
I can add one example of using PREFIX near this section.
There was a problem hiding this comment.
Explained in the previous paragraph now.
AkihiroSuda
reviewed
Nov 19, 2024
| @@ -47,6 +46,7 @@ brew install socket_vmnet | |||
| ``` | |||
|
|
|||
| The binaries will be installed onto the following paths: | |||
|
|
|||
There was a problem hiding this comment.
Is this spacing required by some linter? If so, it should be enforced in the CI
There was a problem hiding this comment.
BTW what is the benefit of this spacing style?
There was a problem hiding this comment.
We can use yamllint markdownlint to enforce this. I'll add an issue to add it.
There was a problem hiding this comment.
The source is more clear. The rendered page looks the same.
AkihiroSuda
reviewed
Nov 20, 2024
We use PRFIX=/opt/socket_vment by default, and we recommend to use the default location for good reasons. Show the recommend commands without the unneeded PREFIX. Mention PREFIX in the next paragraph about avoiding bad locations like /usr/local. Using non-default location introduces the risk of using a directory writable by unprivileged user and complicates lima configuration which defaults to /opt/socket_vmnet. Signed-off-by: Nir Soffer <nsoffer@redhat.com>
- Improve instructions for enabling debug logs - Mention that stdout is not used for logging - Remove HOMEBREW_PREFIX from logs locations since homebrew installation is not recommended. - Remove note about old logs location Fixes: lima-vm#70 Signed-off-by: Nir Soffer <nsoffer@redhat.com>
On managed machines, this happens after every reboot. `/usr/libexec/bootpd` is already part of the firewall and configured to accept incoming connections. Removing it from the firewall and adding it again fixes the issue. On other machines that do not have this issue, removing and adding bootpd from the firewall is not needed but also does not cause any issue. Fixes: lima-vm#62 Signed-off-by: Nir Soffer <nsoffer@redhat.com>
The current syntax works, but the tables looks better when reading the source this way. (Automatic formatting by Zed markdown extension). Signed-off-by: Nir Soffer <nsoffer@redhat.com>
Change done by formatting the file with Zed markdown extension. Not sure why it is better, but using this makes it easier for me to keep the file nicely formatted. Signed-off-by: Nir Soffer <nsoffer@redhat.com>
It is easier to read the source when sections are separated by blank lines. (Automatically formatted by Zed markdown extension). Signed-off-by: Nir Soffer <nsoffer@redhat.com>
Github supports alert extensions which are rendered much nicer. Examples: > [!NOTE] > Highlights information that users should take into account, even when skimming. > [!TIP] > Optional information to help a user be more successful. > [!IMPORTANT] > Crucial information necessary for users to succeed. > [!WARNING] > Critical content demanding immediate user attention due to potential risks. > [!CAUTION] > Negative potential consequences of an action. [1] https://github.com/orgs/community/discussions/16925 Signed-off-by: Nir Soffer <nsoffer@redhat.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Preview changes