-
Notifications
You must be signed in to change notification settings - Fork 13
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
base: master
Are you sure you want to change the base?
Detailed installation instructions for Ubuntu #275
Conversation
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
UbuntuInstallation.md
Outdated
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
(More detailed instructions for installing on Ubuntu can be found at [UbuntuInstallation.md](./docs/UbuntuInstallation.md)) | ||
|
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
Thanks @bbresearcher! I've left a few style nitpicks, but this LGTM overall in terms of content. Some thoughts:
|
Co-authored-by: William Woodruff <[email protected]>
Co-authored-by: William Woodruff <[email protected]>
Co-authored-by: William Woodruff <[email protected]>
Thank you I have made the suggested changes. |
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.