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

Detailed installation instructions for Ubuntu #275

Open
wants to merge 12 commits into
base: master
Choose a base branch
from

Conversation

bbresearcher
Copy link

I installed siderophile to test some rust code, but I ran into a few errors that I needed to find a workaround for.
I decided to document the process for both the crates.io and the github build process.
For each method's installation a fresh Ubuntu VM was set up.
Please feel free to decline to PR should it not be something you feel is needed.

Adding instructions, to assist with installation on Ubuntu based linux distros
Adding instructions, to assist with installation on Ubuntu based linux distros
Adding instructions, to assist with installation on Ubuntu based linux distros
Adding instructions, to assist with installation on Ubuntu based linux distros
@bbresearcher bbresearcher requested a review from woodruffw as a code owner June 1, 2024 17:13
@CLAassistant
Copy link

CLAassistant commented Jun 1, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Member

Choose a reason for hiding this comment

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

Could you put this under a new docs/ subdirectory? I think that'll help keep the project's root a little simpler.

Copy link
Author

Choose a reason for hiding this comment

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

I have moved the file to the new directory, and also updated the readme with the new path, I also used to opportunity to fix typos I found.
Thank you for considering the contribution.

Moving the installation instructions to a new docs directory
Deleting the existing instructions file in the root directory
README.md Outdated
Comment on lines 28 to 29
(More detailed instructions for installing on Ubuntu can be found at [UbuntuInstallation.md](./docs/UbuntuInstallation.md))

Copy link
Member

Choose a reason for hiding this comment

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

Nitpick: maybe move this below the other installation instructions, since it's more specific than everything else?

Copy link
Author

Choose a reason for hiding this comment

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

Thank you I have moved the position to the bottom of the section

@woodruffw
Copy link
Member

Thanks @bbresearcher! I've left a few style nitpicks, but this LGTM overall in terms of content. Some thoughts:

  1. I'm so-so on including high-level steps like "install cURL" and "install Rust" -- IMO these could just be links or omitted entirely, since a user who wants to scan a Rust crate with siderophile probably already has Rust installed or knows enough about Rust to install it.
  2. I'm okay with this being a separate documentation file, but IMO it could also just go on the wiki instead.

@bbresearcher
Copy link
Author

Thank you I have made the suggested changes.
I am more than happy for the instructions to be moved to a wiki (apologies I tried to follow the link in your comment, but I can't find the wiki folder).
I am also more than happy if you prefer to not include these instructions in the github repository.

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