Skip to content

Added install instructions to readme#3

Open
m10x wants to merge 2 commits into
XanClic:masterfrom
m10x:patch-1
Open

Added install instructions to readme#3
m10x wants to merge 2 commits into
XanClic:masterfrom
m10x:patch-1

Conversation

@m10x
Copy link
Copy Markdown

@m10x m10x commented Dec 20, 2023

No description provided.

@XanClic
Copy link
Copy Markdown
Owner

XanClic commented Feb 10, 2024

Hey, sorry for the long delay. Thanks for the suggestion!

I’m not opposed to adding exemplary build instructions, but what to do depends on the system, so it should be clear in every step that it’s an example.

1. install rust: `curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh`

How to install Rust best depends entirely on the needs and wants of the user; some (most?) prefer rustup, some prefer tracking rustc and cargo through their package manager. Personally, I’m not a fan of suggesting to run some shellscript off the internet without verifying its contents first. (I’ve always installed rustup through my package manager.) We can certainly point to rustup, and point to https://rustup.rs for installation options, then the way they recommend is at least off of our hands. (E.g. “install rust, e.g. through rustup (see https://rustup.rs for installation options)”.)

3. install needed packages: `sudo apt-get install libusb-1.0-0-dev pkg-config`

How to install these packages again depends on the system. I, for example, don’t have any that uses APT. We can certainly point out that building requires the libusb1 devel package (“package name depends on your system, e.g. ‘libusb-1.0-0-dev’ or ‘libusb1-devel’”) and pkg-config.

As for building/installing, well, it’s cargo. What I usually do is just cargo build --release and then grab the binary from target/release.

@m10x
Copy link
Copy Markdown
Author

m10x commented Feb 10, 2024

I've never used Rust before, so it took me a while to figure out how to run your tool. That's why I thought that some kind of guidance would be great for other Rust noobs like me. But, yeah, you're right. The steps depend heavily on the system used. :)

@kaitlynia
Copy link
Copy Markdown

I think just mentioning that you need Rust, including cargo build --release as the recommended step to build, and including some note about libusb is sufficient

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