From f24a7c885b367a796f183c81c8d5d262e878019d Mon Sep 17 00:00:00 2001 From: bbresearcher <114293365+bbresearcher@users.noreply.github.com> Date: Sat, 1 Jun 2024 18:57:27 +0200 Subject: [PATCH 01/12] chore: Add Ubuntu install instructions Adding instructions, to assist with installation on Ubuntu based linux distros --- UbuntuInstallation.md | 103 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 UbuntuInstallation.md diff --git a/UbuntuInstallation.md b/UbuntuInstallation.md new file mode 100644 index 0000000..89f039f --- /dev/null +++ b/UbuntuInstallation.md @@ -0,0 +1,103 @@ +# Installing Siderophile on a fresh installation of Ubuntu +## Prerequisites +1. Install curl if its not installed : `sudo apt install curl` +2. Install Rust; follow instructions at: [The Official Rust Documentation](https://doc.rust-lang.org/book/ch01-01-installation.html) +3. Install a compiler linker like GCC or Clang: `sudo apt install build-essential` + +## Installing using crates.io +1. Install Siderophile using the command : `cargo install siderophile` +2. You may get an error while compiling openssl-sys : `error: failed to run custom build command for openssl-sys v0.9.102` +3. You can fix the above error by installing the libssl-dev package : `sudo apt install pkg-config libssl-dev` +4. Reload the profile : `. ~/.profile` +5. Re-issue the cargo install command: `cargo install siderophile` +6. You may get an error as below: +``` +error: No suitable version of LLVM was found system-wide or pointed + to by LLVM_SYS_140_PREFIX. +``` +7. To fix this you can install the missing version, the version is the number in the error text above eg. 140 or perhaps 170. In the above isntance it will be: `sudo apt install llvm-14` +8. You may get an error about missing library `Polly` as below +``` +error: could not find native static library `Polly`, perhaps an -L flag is missing? +``` +9. To fix this error you can install the missing package(once agian taking into account the correct version): `sudo apt install libpolly-14-dev` +10. Once the installation is finished running the help command will confirm the installation has completed successfully + ``` + siderophile --help + siderophile 0.2.1 + + USAGE: + siderophile [FLAGS] [OPTIONS] + + FLAGS: + --include-tests Count unsafe usage in tests + --no-mark-closures Do not mark closures + -h, --help Prints help information + -V, --version Prints version information + + OPTIONS: + --crate-name Crate name (deprecated) + -p, --package Package to be used as the root of the tree + --mark Mark bad functions with TEXT + --threshold Minimum badness required to mark a function [default: 0] + ``` + + + +## Installing by building from github +1. Before cloning the siderophile repository we will need to install the git command using: `sudo apt install git` +2. Check the installation by issuing the command : `git --version` it should return a value similar to below: +``` +git version 2.43.0 +``` +3. Create a new directory and change the working directory for the project eg. `mkdir siderophile_build && cd ./siderophile_build` +4. Clone the repo and cd into the siderophile driectory : `git clone https://github.com/trailofbits/siderophile && cd ./siderophile` +5. Use the cargo build command to build the project : `cargo build` +6. You may get the following error while compiling openssl-sys : `error: failed to run custom build command for openssl-sys v0.9.99` +7. You can fix the above error by installing the libssl-dev package : `sudo apt install pkg-config libssl-dev` +8. Reload the profile : `. ~/.proofile` +9. You may get an error as below: +``` +error: No suitable version of LLVM was found system-wide or pointed + to by LLVM_SYS_170_PREFIX. +``` +10. There are two possible fixes, and you may need to action one or both + - The first way to fix this is to install the missing version, the version is the number in the error text above eg. 140 or perhaps 170. In the above isntance it will be: `sudo apt install llvm-17` + - Or you may need to set the library in the cargo build command by issuing the command : `LLVM_SYS_170_PREFIX=/usr/lib/llvm-17 cargo build` +11. You may get an error about a missing library `Polly` as below +``` +error: could not find native static library `Polly`, perhaps an -L flag is missing? +``` +12. To fix this error you can install the missing package(once agian taking into account the correct version): `sudo apt install libpolly-17-dev` +13. Reload the profile : `. ~/.profile` +14 You may get an error about a missing linking library `cc` and the description lower down in the error text about `libzstd` missing as below +``` +error: linking with `cc` failed: exit status: 1 +.... +.... +/usr/bin/ld: cannot find -lzstd: No such file or directory +``` +15. To fix this error you can install the missing package: `sudo apt install libzstd-dev` +16. The compiler may show errors but it will compile +17. Siderophile can then be installed using the command: `cargo install --path .` +18. Running the help command will confirm the installation has completed successfully + ``` + siderophile --help + siderophile 0.2.1 + + USAGE: + siderophile [FLAGS] [OPTIONS] + + FLAGS: + --include-tests Count unsafe usage in tests + --no-mark-closures Do not mark closures + -h, --help Prints help information + -V, --version Prints version information + + OPTIONS: + --crate-name Crate name (deprecated) + -p, --package Package to be used as the root of the tree + --mark Mark bad functions with TEXT + --threshold Minimum badness required to mark a function [default: 0] + ``` + From 26f86c8490cfec6eba274028b806cf3797a6cf6e Mon Sep 17 00:00:00 2001 From: bbresearcher <114293365+bbresearcher@users.noreply.github.com> Date: Sat, 1 Jun 2024 19:00:32 +0200 Subject: [PATCH 02/12] chore: Add Ubuntu install instructions Adding instructions, to assist with installation on Ubuntu based linux distros --- UbuntuInstallation.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/UbuntuInstallation.md b/UbuntuInstallation.md index 89f039f..08124ff 100644 --- a/UbuntuInstallation.md +++ b/UbuntuInstallation.md @@ -1,4 +1,6 @@ # Installing Siderophile on a fresh installation of Ubuntu +This page documents the installation process of Siderophile on a fresh installation of Ubuntu. +There are two methods to install (cartes.io or Github) and both are documented below. ## Prerequisites 1. Install curl if its not installed : `sudo apt install curl` 2. Install Rust; follow instructions at: [The Official Rust Documentation](https://doc.rust-lang.org/book/ch01-01-installation.html) From 82dacf256e6a1f9e17e7518cb1ff300ca2ddb790 Mon Sep 17 00:00:00 2001 From: bbresearcher <114293365+bbresearcher@users.noreply.github.com> Date: Sat, 1 Jun 2024 19:01:03 +0200 Subject: [PATCH 03/12] chore: Add Ubuntu install instructions Adding instructions, to assist with installation on Ubuntu based linux distros --- UbuntuInstallation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/UbuntuInstallation.md b/UbuntuInstallation.md index 08124ff..bb30bec 100644 --- a/UbuntuInstallation.md +++ b/UbuntuInstallation.md @@ -1,6 +1,6 @@ # Installing Siderophile on a fresh installation of Ubuntu This page documents the installation process of Siderophile on a fresh installation of Ubuntu. -There are two methods to install (cartes.io or Github) and both are documented below. +There are two methods to install (crates.io or Github) and both are documented below. ## Prerequisites 1. Install curl if its not installed : `sudo apt install curl` 2. Install Rust; follow instructions at: [The Official Rust Documentation](https://doc.rust-lang.org/book/ch01-01-installation.html) From 36e13fa37648c8cf3e23dd1ac8014899ac1a3db4 Mon Sep 17 00:00:00 2001 From: bbresearcher <114293365+bbresearcher@users.noreply.github.com> Date: Sat, 1 Jun 2024 19:04:57 +0200 Subject: [PATCH 04/12] chore: Add Ubuntu install instructions Adding instructions, to assist with installation on Ubuntu based linux distros --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 7034d19..a3320c4 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,8 @@ marking unsafe functions with a `*`, suppose your function `f` calls functions Functions with high badness have a lot of opportunities to be memory unsafe. ## Installation +(More detailed instructions for installing on Ubuntu can be found at [UbuntuInstallation.md](./UbuntuInstallation.md)) + Siderophile is [available via crates.io](https://crates.io/crates/siderophile), and can be installed with `cargo`: From b7c46ca717ae4839ac3f9d1116a6bdae04e455c9 Mon Sep 17 00:00:00 2001 From: bbresearcher <114293365+bbresearcher@users.noreply.github.com> Date: Wed, 5 Jun 2024 18:35:24 +0200 Subject: [PATCH 05/12] chore: Move to docs directory and fix typos Moving the installation instructions to a new docs directory --- docs/UbuntuInstallation.md | 105 +++++++++++++++++++++++++++++++++++++ 1 file changed, 105 insertions(+) create mode 100644 docs/UbuntuInstallation.md diff --git a/docs/UbuntuInstallation.md b/docs/UbuntuInstallation.md new file mode 100644 index 0000000..83e01df --- /dev/null +++ b/docs/UbuntuInstallation.md @@ -0,0 +1,105 @@ +# Installing Siderophile on a fresh installation of Ubuntu +This page documents the installation process of Siderophile on a fresh installation of Ubuntu. +There are two methods to install (crates.io or Github) and both are documented below. +## Prerequisites +1. Install curl if its not installed : `sudo apt install curl` +2. Install Rust; follow instructions at: [The Official Rust Documentation](https://doc.rust-lang.org/book/ch01-01-installation.html) +3. Install a compiler linker like GCC or Clang: `sudo apt install build-essential` + +## Installing using crates.io +1. Install Siderophile using the command : `cargo install siderophile` +2. You may get an error while compiling openssl-sys : `error: failed to run custom build command for openssl-sys v0.9.102` +3. You can fix the above error by installing the libssl-dev package : `sudo apt install pkg-config libssl-dev` +4. Reload the profile : `. ~/.profile` +5. Re-issue the cargo install command: `cargo install siderophile` +6. You may get an error as below: +``` +error: No suitable version of LLVM was found system-wide or pointed + to by LLVM_SYS_140_PREFIX. +``` +7. To fix this you can install the missing version, the version is the number in the error text above eg. 140 or perhaps 170. In the above instance it will be: `sudo apt install llvm-14` +8. You may get an error about missing library `Polly` as below +``` +error: could not find native static library `Polly`, perhaps an -L flag is missing? +``` +9. To fix this error you can install the missing package(once agian taking into account the correct version): `sudo apt install libpolly-14-dev` +10. Once the installation is finished running the help command will confirm the installation has completed successfully + ``` + siderophile --help + siderophile 0.2.1 + + USAGE: + siderophile [FLAGS] [OPTIONS] + + FLAGS: + --include-tests Count unsafe usage in tests + --no-mark-closures Do not mark closures + -h, --help Prints help information + -V, --version Prints version information + + OPTIONS: + --crate-name Crate name (deprecated) + -p, --package Package to be used as the root of the tree + --mark Mark bad functions with TEXT + --threshold Minimum badness required to mark a function [default: 0] + ``` + + + +## Installing by building from github +1. Before cloning the siderophile repository we will need to install the git command using: `sudo apt install git` +2. Check the installation by issuing the command : `git --version` it should return a value similar to below: +``` +git version 2.43.0 +``` +3. Create a new directory and change the working directory for the project eg. `mkdir siderophile_build && cd ./siderophile_build` +4. Clone the repo and cd into the siderophile driectory : `git clone https://github.com/trailofbits/siderophile && cd ./siderophile` +5. Use the cargo build command to build the project : `cargo build` +6. You may get the following error while compiling openssl-sys : `error: failed to run custom build command for openssl-sys v0.9.99` +7. You can fix the above error by installing the libssl-dev package : `sudo apt install pkg-config libssl-dev` +8. Reload the profile : `. ~/.proofile` +9. You may get an error as below: +``` +error: No suitable version of LLVM was found system-wide or pointed + to by LLVM_SYS_170_PREFIX. +``` +10. There are two possible fixes, and you may need to action one or both + - The first way to fix this is to install the missing version, the version is the number in the error text above eg. 140 or perhaps 170. In the above instance it will be: `sudo apt install llvm-17` + - Or you may need to set the library in the cargo build command by issuing the command : `LLVM_SYS_170_PREFIX=/usr/lib/llvm-17 cargo build` +11. You may get an error about a missing library `Polly` as below +``` +error: could not find native static library `Polly`, perhaps an -L flag is missing? +``` +12. To fix this error you can install the missing package(once again taking into account the correct version): `sudo apt install libpolly-17-dev` +13. Reload the profile : `. ~/.profile` +14 You may get an error about a missing linking library `cc` and the description lower down in the error text about `libzstd` missing as below +``` +error: linking with `cc` failed: exit status: 1 +.... +.... +/usr/bin/ld: cannot find -lzstd: No such file or directory +``` +15. To fix this error you can install the missing package: `sudo apt install libzstd-dev` +16. The compiler may show errors but it will compile +17. Siderophile can then be installed using the command: `cargo install --path .` +18. Running the help command will confirm the installation has completed successfully + ``` + siderophile --help + siderophile 0.2.1 + + USAGE: + siderophile [FLAGS] [OPTIONS] + + FLAGS: + --include-tests Count unsafe usage in tests + --no-mark-closures Do not mark closures + -h, --help Prints help information + -V, --version Prints version information + + OPTIONS: + --crate-name Crate name (deprecated) + -p, --package Package to be used as the root of the tree + --mark Mark bad functions with TEXT + --threshold Minimum badness required to mark a function [default: 0] + ``` + From c04a464ab8828eb8cfebd9670a74dc0953a15257 Mon Sep 17 00:00:00 2001 From: bbresearcher <114293365+bbresearcher@users.noreply.github.com> Date: Wed, 5 Jun 2024 18:36:57 +0200 Subject: [PATCH 06/12] chore: removing instructions file from root directory Deleting the existing instructions file in the root directory --- UbuntuInstallation.md | 105 ------------------------------------------ 1 file changed, 105 deletions(-) delete mode 100644 UbuntuInstallation.md diff --git a/UbuntuInstallation.md b/UbuntuInstallation.md deleted file mode 100644 index bb30bec..0000000 --- a/UbuntuInstallation.md +++ /dev/null @@ -1,105 +0,0 @@ -# Installing Siderophile on a fresh installation of Ubuntu -This page documents the installation process of Siderophile on a fresh installation of Ubuntu. -There are two methods to install (crates.io or Github) and both are documented below. -## Prerequisites -1. Install curl if its not installed : `sudo apt install curl` -2. Install Rust; follow instructions at: [The Official Rust Documentation](https://doc.rust-lang.org/book/ch01-01-installation.html) -3. Install a compiler linker like GCC or Clang: `sudo apt install build-essential` - -## Installing using crates.io -1. Install Siderophile using the command : `cargo install siderophile` -2. You may get an error while compiling openssl-sys : `error: failed to run custom build command for openssl-sys v0.9.102` -3. You can fix the above error by installing the libssl-dev package : `sudo apt install pkg-config libssl-dev` -4. Reload the profile : `. ~/.profile` -5. Re-issue the cargo install command: `cargo install siderophile` -6. You may get an error as below: -``` -error: No suitable version of LLVM was found system-wide or pointed - to by LLVM_SYS_140_PREFIX. -``` -7. To fix this you can install the missing version, the version is the number in the error text above eg. 140 or perhaps 170. In the above isntance it will be: `sudo apt install llvm-14` -8. You may get an error about missing library `Polly` as below -``` -error: could not find native static library `Polly`, perhaps an -L flag is missing? -``` -9. To fix this error you can install the missing package(once agian taking into account the correct version): `sudo apt install libpolly-14-dev` -10. Once the installation is finished running the help command will confirm the installation has completed successfully - ``` - siderophile --help - siderophile 0.2.1 - - USAGE: - siderophile [FLAGS] [OPTIONS] - - FLAGS: - --include-tests Count unsafe usage in tests - --no-mark-closures Do not mark closures - -h, --help Prints help information - -V, --version Prints version information - - OPTIONS: - --crate-name Crate name (deprecated) - -p, --package Package to be used as the root of the tree - --mark Mark bad functions with TEXT - --threshold Minimum badness required to mark a function [default: 0] - ``` - - - -## Installing by building from github -1. Before cloning the siderophile repository we will need to install the git command using: `sudo apt install git` -2. Check the installation by issuing the command : `git --version` it should return a value similar to below: -``` -git version 2.43.0 -``` -3. Create a new directory and change the working directory for the project eg. `mkdir siderophile_build && cd ./siderophile_build` -4. Clone the repo and cd into the siderophile driectory : `git clone https://github.com/trailofbits/siderophile && cd ./siderophile` -5. Use the cargo build command to build the project : `cargo build` -6. You may get the following error while compiling openssl-sys : `error: failed to run custom build command for openssl-sys v0.9.99` -7. You can fix the above error by installing the libssl-dev package : `sudo apt install pkg-config libssl-dev` -8. Reload the profile : `. ~/.proofile` -9. You may get an error as below: -``` -error: No suitable version of LLVM was found system-wide or pointed - to by LLVM_SYS_170_PREFIX. -``` -10. There are two possible fixes, and you may need to action one or both - - The first way to fix this is to install the missing version, the version is the number in the error text above eg. 140 or perhaps 170. In the above isntance it will be: `sudo apt install llvm-17` - - Or you may need to set the library in the cargo build command by issuing the command : `LLVM_SYS_170_PREFIX=/usr/lib/llvm-17 cargo build` -11. You may get an error about a missing library `Polly` as below -``` -error: could not find native static library `Polly`, perhaps an -L flag is missing? -``` -12. To fix this error you can install the missing package(once agian taking into account the correct version): `sudo apt install libpolly-17-dev` -13. Reload the profile : `. ~/.profile` -14 You may get an error about a missing linking library `cc` and the description lower down in the error text about `libzstd` missing as below -``` -error: linking with `cc` failed: exit status: 1 -.... -.... -/usr/bin/ld: cannot find -lzstd: No such file or directory -``` -15. To fix this error you can install the missing package: `sudo apt install libzstd-dev` -16. The compiler may show errors but it will compile -17. Siderophile can then be installed using the command: `cargo install --path .` -18. Running the help command will confirm the installation has completed successfully - ``` - siderophile --help - siderophile 0.2.1 - - USAGE: - siderophile [FLAGS] [OPTIONS] - - FLAGS: - --include-tests Count unsafe usage in tests - --no-mark-closures Do not mark closures - -h, --help Prints help information - -V, --version Prints version information - - OPTIONS: - --crate-name Crate name (deprecated) - -p, --package Package to be used as the root of the tree - --mark Mark bad functions with TEXT - --threshold Minimum badness required to mark a function [default: 0] - ``` - From 3360689d2ba76fa896606105a61deaa0d76db37c Mon Sep 17 00:00:00 2001 From: bbresearcher <114293365+bbresearcher@users.noreply.github.com> Date: Wed, 5 Jun 2024 18:38:42 +0200 Subject: [PATCH 07/12] chore: Update path to Ubuntu installation file to docs directory --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a3320c4..ea5fcf8 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ marking unsafe functions with a `*`, suppose your function `f` calls functions Functions with high badness have a lot of opportunities to be memory unsafe. ## Installation -(More detailed instructions for installing on Ubuntu can be found at [UbuntuInstallation.md](./UbuntuInstallation.md)) +(More detailed instructions for installing on Ubuntu can be found at [UbuntuInstallation.md](./docs/UbuntuInstallation.md)) Siderophile is [available via crates.io](https://crates.io/crates/siderophile), From e45f5552ded9c3ddb20f97db2a422278e9129186 Mon Sep 17 00:00:00 2001 From: bbresearcher <114293365+bbresearcher@users.noreply.github.com> Date: Wed, 5 Jun 2024 19:51:24 +0200 Subject: [PATCH 08/12] fix: accept suggested changes Co-authored-by: William Woodruff --- docs/UbuntuInstallation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UbuntuInstallation.md b/docs/UbuntuInstallation.md index 83e01df..4c93f2e 100644 --- a/docs/UbuntuInstallation.md +++ b/docs/UbuntuInstallation.md @@ -65,7 +65,7 @@ error: No suitable version of LLVM was found system-wide or pointed ``` 10. There are two possible fixes, and you may need to action one or both - The first way to fix this is to install the missing version, the version is the number in the error text above eg. 140 or perhaps 170. In the above instance it will be: `sudo apt install llvm-17` - - Or you may need to set the library in the cargo build command by issuing the command : `LLVM_SYS_170_PREFIX=/usr/lib/llvm-17 cargo build` + - Or you may need to set the library in the cargo build command by issuing the command: `LLVM_SYS_170_PREFIX=/usr/lib/llvm-17 cargo build` 11. You may get an error about a missing library `Polly` as below ``` error: could not find native static library `Polly`, perhaps an -L flag is missing? From 47121c1e349e8c98d5c2de126a03ee8e084650c5 Mon Sep 17 00:00:00 2001 From: bbresearcher <114293365+bbresearcher@users.noreply.github.com> Date: Wed, 5 Jun 2024 19:51:36 +0200 Subject: [PATCH 09/12] fix: accept suggested changes Co-authored-by: William Woodruff --- docs/UbuntuInstallation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UbuntuInstallation.md b/docs/UbuntuInstallation.md index 4c93f2e..c3bc151 100644 --- a/docs/UbuntuInstallation.md +++ b/docs/UbuntuInstallation.md @@ -71,7 +71,7 @@ error: No suitable version of LLVM was found system-wide or pointed error: could not find native static library `Polly`, perhaps an -L flag is missing? ``` 12. To fix this error you can install the missing package(once again taking into account the correct version): `sudo apt install libpolly-17-dev` -13. Reload the profile : `. ~/.profile` +13. Reload the profile: `. ~/.profile` 14 You may get an error about a missing linking library `cc` and the description lower down in the error text about `libzstd` missing as below ``` error: linking with `cc` failed: exit status: 1 From 285ced7ec0046fb9c90a5dd0fb3f34b970ef9418 Mon Sep 17 00:00:00 2001 From: bbresearcher <114293365+bbresearcher@users.noreply.github.com> Date: Wed, 5 Jun 2024 19:51:48 +0200 Subject: [PATCH 10/12] fix: accept suggested changes Co-authored-by: William Woodruff --- docs/UbuntuInstallation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UbuntuInstallation.md b/docs/UbuntuInstallation.md index c3bc151..c519e9b 100644 --- a/docs/UbuntuInstallation.md +++ b/docs/UbuntuInstallation.md @@ -70,7 +70,7 @@ error: No suitable version of LLVM was found system-wide or pointed ``` error: could not find native static library `Polly`, perhaps an -L flag is missing? ``` -12. To fix this error you can install the missing package(once again taking into account the correct version): `sudo apt install libpolly-17-dev` +12. To fix this error you can install the missing package (once again taking into account the correct version): `sudo apt install libpolly-17-dev` 13. Reload the profile: `. ~/.profile` 14 You may get an error about a missing linking library `cc` and the description lower down in the error text about `libzstd` missing as below ``` From eca8f1d4c2bac2092f9445dffc3088d7dc71a790 Mon Sep 17 00:00:00 2001 From: bbresearcher <114293365+bbresearcher@users.noreply.github.com> Date: Wed, 5 Jun 2024 19:55:07 +0200 Subject: [PATCH 11/12] fix: move Ubuntu instructions to bottom of section --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ea5fcf8..1409163 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,6 @@ marking unsafe functions with a `*`, suppose your function `f` calls functions Functions with high badness have a lot of opportunities to be memory unsafe. ## Installation -(More detailed instructions for installing on Ubuntu can be found at [UbuntuInstallation.md](./docs/UbuntuInstallation.md)) Siderophile is [available via crates.io](https://crates.io/crates/siderophile), @@ -108,6 +107,8 @@ cargo install --path . You may need the same `LLVM_SYS_170_PATH` and `LIBRARY_PATH` overrides mentioned above. +(More detailed instructions for installing on Ubuntu can be found at [UbuntuInstallation.md](./docs/UbuntuInstallation.md)) + ## How to use Make sure that you followed the above steps, then do the following: From 520ba7aa1937436188f67f43a244af66ec946043 Mon Sep 17 00:00:00 2001 From: bbresearcher <114293365+bbresearcher@users.noreply.github.com> Date: Wed, 5 Jun 2024 20:08:53 +0200 Subject: [PATCH 12/12] fix: Removing prerequisites section --- docs/UbuntuInstallation.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docs/UbuntuInstallation.md b/docs/UbuntuInstallation.md index c519e9b..498143f 100644 --- a/docs/UbuntuInstallation.md +++ b/docs/UbuntuInstallation.md @@ -1,11 +1,6 @@ # Installing Siderophile on a fresh installation of Ubuntu This page documents the installation process of Siderophile on a fresh installation of Ubuntu. There are two methods to install (crates.io or Github) and both are documented below. -## Prerequisites -1. Install curl if its not installed : `sudo apt install curl` -2. Install Rust; follow instructions at: [The Official Rust Documentation](https://doc.rust-lang.org/book/ch01-01-installation.html) -3. Install a compiler linker like GCC or Clang: `sudo apt install build-essential` - ## Installing using crates.io 1. Install Siderophile using the command : `cargo install siderophile` 2. You may get an error while compiling openssl-sys : `error: failed to run custom build command for openssl-sys v0.9.102`