Improve README.md with package instructions and formatting (#1, #4) #6
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Restructured Markdown content to follow the one-sentence-per-line convention. This improves readability of diffs in version control. Makes future edits more trackable. No content changes, only formatting modifications. Signed-off-by: editheman <edipana0409@gmail.com>
…alus-security#4) Added comprehensive installation instructions for required dependencies across multiple platforms: - macOS (via Homebrew) - Ubuntu/Debian - Fedora/RHEL/CentOS - Arch Linux This enables users to properly set up their environment before building vfdecrypt locally. Signed-off-by: editheman <edipana0409@gmail.com>
razvand
reviewed
Dec 5, 2025
Member
razvand
left a comment
razvand
left a comment
There was a problem hiding this comment.
Squash commits into a single commit.
| We've used and updated the implementation [here](https://github.com/trailofbits/iverify-oss/tree/master/vendor/vfdecrypt). | ||
| We've updated `vfdecrypt.c` to support OpenSSL >= 1.1.0 and the `Makefile` to be OS-dependent. | ||
|
|
||
| ### Dependencies |
Member
There was a problem hiding this comment.
Use macOS, Ubuntu/Debian etc. as lists (* macOS, * Ubuntu/Debian etc.).
|
|
||
| macOS | ||
|
|
||
| ``` |
|
|
||
| Ubuntu/Debian | ||
|
|
||
| ``` |
| Ubuntu/Debian | ||
|
|
||
| ``` | ||
| sudo apt-get update sudo apt-get install -y build-essential libssl-dev coreutils |
Member
There was a problem hiding this comment.
Suggested change
| sudo apt-get update sudo apt-get install -y build-essential libssl-dev coreutils | |
| sudo apt-get update | |
| sudo apt-get install -y build-essential libssl-dev coreutils |
|
|
||
| Fedora/RHEL/CentOS | ||
|
|
||
| ``` |
|
|
||
| Arch Linux | ||
|
|
||
| ``` |
|
|
||
| You build `vfdecrypt` using | ||
|
|
||
| ``` |
Member
There was a problem hiding this comment.
Use triple backticks and console.
| You runn `vfdecrypt` by passing it the root filesystem key, the root filesystem image and the output (decrypted) file: | ||
| You run `vfdecrypt` by passing it the root filesystem key, the root filesystem image and the output (decrypted) file: | ||
|
|
||
| ``` |
Member
There was a problem hiding this comment.
Use triple backticks and console.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR enhances the README.md file in two significant ways to improve user experience and code maintainability.
Changes
Added platform-specific package installation instructions (Add local instructions on install required packages (for Linux, for Mac) #4)
Added comprehensive dependency installation instructions for multiple platforms:
-macOS (via Homebrew)
-Ubuntu/Debian
-Fedora/RHEL/CentOS
-Arch Linux
This enables users to properly set up their environment before building vfdecrypt locally without guesswork.
Standardized Markdown formatting (Use one sentence per-line in README.md #1)
Restructured the Markdown content to follow the one-sentence-per-line convention which:
-Improves readability of diffs in version control
-Makes future edits more trackable
-Ensures consistent styling across documentation