Linux build docs#62
Open
ckateraas wants to merge 2 commits intoFiloSottile:mainfrom
ckateraas:linux-build-docs
Open
Linux build docs#62ckateraas wants to merge 2 commits intoFiloSottile:mainfrom ckateraas:linux-build-docs
ckateraas wants to merge 2 commits intoFiloSottile:mainfrom
ckateraas:linux-build-docs
Conversation
added 2 commits
October 16, 2020 13:25
Hopefully makes the docs for building on distros without pre-made packages easier to use. - Restructure the docs for building into sections for dependencies, building, and using. - List packages needed for Ubuntu 20.04. - Replace code snippets' syntax from text to sh. - Remove leading $ from code snippets meant for copypasting without cmd output following. - Highlight that `pcscd.socket` must be active before using `yubikey-agent`. - Add instructions for how to set SSH_AUTH_SOCK if you are using Fish shell
|
As a Linux user, looks good to me. Perhaps the maintainer would prefer that distro-specific details are moved to a wiki where he doesn't have to maintain them in the README, but that's up to him. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
First off, thanks for creating
yubikey-agent!I just installed it on Ubuntu 20.04 and thought I could write down the steps I did to get it working on Ubuntu 20.04.
This spiraled out and I ended up rewriting large parts of the contents in
system.md😅Intent
Hopefully make the instructions for building
yubikey-agent, on any distribution, easier to follow.Changes
Since there's a handful of changes, here's a summary of what's been done
textwithshfor code snippets containing shell commands.building, and using.
$from code snippets without any following command output, for faster copypasting.pcscd.socketmust be active before usingyubikey-agent -setup.SSH_AUTH_SOCKif you are using Fish shell.