Skip to content

Update Linux install instructions#991

Merged
dericed merged 1 commit into
mainfrom
linux-doc-updates
May 22, 2026
Merged

Update Linux install instructions#991
dericed merged 1 commit into
mainfrom
linux-doc-updates

Conversation

@privatezero
Copy link
Copy Markdown
Member

Updated Linux install docs to simplify the process and remove out of date information - this process is working in my VM test so far.

@privatezero privatezero requested a review from dericed May 14, 2026 00:12
Copy link
Copy Markdown
Member

@retokromer retokromer left a comment

Choose a reason for hiding this comment

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

one nit, but LGTM


### Programs to be installed manually
To do this, make sure `curl` is installed (and if not, run `sudo apt install curl`). Then running the following command will install vrecord dependencies:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

You could also add a test in the linux-dependencies.sh‎ script and, if not already installed, do it.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Bit of a catch-22 though, because ideally people will use curl to run linux-dependencies.sh, so can't really have it run a check to see if curl is present if they need curl to run it.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Indeed! Then my nit is void.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

If curl is not yet installed, then wget would also do the trick:

wget -O - https://raw.githubusercontent.com/amiaopensource/vrecord/refs/heads/linux-doc-updates/Release/linux-dependencies.sh | bash

I guess, wget comes with Ubuntu? If that is correct, then wget could check and when needed install curl.

(I personally prefer curl for many reasons.)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Good point - wget is included out of the box. I think I'll shift the recommended command here to wget and then add curl into the dependencies script. I don't think it's even necessary to do a check really, as apt-get will just skip it if it is already installed. Either way, curl is necessary for running the following Homebrew install step, so it will have to be installed one way or another.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Just made that change and squished it - thanks for the suggestion!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Good point indeed, apt-get needs it!

@privatezero
Copy link
Copy Markdown
Member Author

@dericed @bturkus, anyone else have thoughts about this? Good to merge?

Copy link
Copy Markdown
Member

@dericed dericed left a comment

Choose a reason for hiding this comment

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

LGTM. thx for all this documentation

@dericed dericed merged commit bf4a1c3 into main May 22, 2026
@privatezero privatezero deleted the linux-doc-updates branch May 22, 2026 15:51
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