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

Linux build docs #62

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Linux build docs #62

wants to merge 2 commits into from

Conversation

ckateraas
Copy link

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

  • Replace text with sh for code snippets containing shell commands.
  • Restructure the docs for building into sections for dependencies,
    building, and using.
  • Add link to Golang's official install instructions to help users get started installing Golang.
  • List packages needed for Ubuntu 20.04.
  • Remove leading $ from code snippets without any following command output, for faster copypasting.
  • Highlight that pcscd.socket must be active before using yubikey-agent -setup.
  • Add instructions for how to set SSH_AUTH_SOCK if you are using Fish shell.

Christian 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
Base automatically changed from master to main February 11, 2021 12:14
@markstos
Copy link

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.

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.

2 participants