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

Update Linux build instructions #1454

Merged
merged 1 commit into from
Jun 14, 2024

Conversation

AaronFeickert
Copy link
Contributor

@AaronFeickert AaronFeickert commented Jun 12, 2024

Recent versions of Ubuntu require python3 be specified as a dependency instead of python. This PR updates the documentation accordingly.

Closes #1452.

Copy link

coderabbitai bot commented Jun 12, 2024

Walkthrough

The recent update to the README.md involves a minor but important change in the installation instructions for Ubuntu users. Specifically, it recommends using python3 instead of python, aligning the instructions with the requirements of later Ubuntu versions.

Changes

File Change Summary
README.md Updated installation instructions to recommend python3 for Ubuntu.

Poem

In Ubuntu's land, where code does flow,
A small tweak made, for python3 to show.
Install with ease, no more fuss,
Python's path now clear for us.
🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range and nitpick comments (5)
README.md (5)

Line range hint 14-14: Ensure consistency in word usage: choose either "utilises" or "utilize" throughout the document to maintain style coherence.


Line range hint 16-16: Consider adding a comma after "system" and "algorithm" for better readability.


Line range hint 20-20: Remove the repeated word "the" to correct the sentence: "then running Firo with Docker might be the easier method for you."


Line range hint 173-173: Consider rephrasing for better flow: "Note: These instructions are inherited from Bitcoin and may not work as expected."


Line range hint 196-221: Add alternate text to the images to improve accessibility.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ba702ec and 867e57d.

Files selected for processing (1)
  • README.md (1 hunks)
Additional context used
LanguageTool
README.md

[uncategorized] ~14-~14: Do not mix variants of the same word (‘utilise’ and ‘utilize’) within a single text. (EN_WORD_COHERENCY)
Context: ...pers/LinfengSparkAudit.pdf). Firo also utilises [Dandelion++](https://arxiv.org/abs/180...


[uncategorized] ~16-~16: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...o uses a hybrid PoW and LLMQ Chainlocks system combining fair distribution of supply w...


[uncategorized] ~16-~16: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...W variant) is used as its Proof-of-Work algorithm which targets GPUs and is FPGA/ASIC res...


[duplication] ~20-~20: Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Context: ... then running Firo with Docker might be the the easier method for you. To run Firo usin...


[typographical] ~20-~20: Consider adding a comma here. (TO_THAT_COMMA)
Context: ...type=edition&offering=community). After this you may continue with the following ins...


[grammar] ~98-~98: The verb ‘depend’ requires the preposition ‘on’ (or ‘upon’). (DEPEND_ON)
Context: ...ns such as cross compilation, read the depends instructions Alter...


[style] ~173-~173: To make your writing flow more naturally, try moving ‘also’ before the verb. (ALSO_PLACEMENT)
Context: ...f you chose to build the GUI, firo-qt will be also generated in the qt folder. ## macOS...


[grammar] ~189-~189: The verb ‘to depend’ requires the preposition ‘(up)on’. (DEPEND_ON)
Context: ...mpiled binaries, it's time to run Firo! Depending by your skill level and/or setup, you migh...

Markdownlint
README.md

18-18: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document


95-95: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document


187-187: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document


191-191: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document


125-125: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines


126-126: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines


179-179: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading


185-185: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading


196-196: null (MD045, no-alt-text)
Images should have alternate text (alt text)


206-206: null (MD045, no-alt-text)
Images should have alternate text (alt text)


212-212: null (MD045, no-alt-text)
Images should have alternate text (alt text)


213-213: null (MD045, no-alt-text)
Images should have alternate text (alt text)


214-214: null (MD045, no-alt-text)
Images should have alternate text (alt text)


215-215: null (MD045, no-alt-text)
Images should have alternate text (alt text)


216-216: null (MD045, no-alt-text)
Images should have alternate text (alt text)


217-217: null (MD045, no-alt-text)
Images should have alternate text (alt text)


218-218: null (MD045, no-alt-text)
Images should have alternate text (alt text)


219-219: null (MD045, no-alt-text)
Images should have alternate text (alt text)


220-220: null (MD045, no-alt-text)
Images should have alternate text (alt text)


221-221: null (MD045, no-alt-text)
Images should have alternate text (alt text)

Additional comments not posted (1)
README.md (1)

115-115: The update to specify python3 is clear and relevant for Ubuntu users. Consider adding a specific Ubuntu version to clarify from which version this change is necessary.

@levonpetrosyan93 levonpetrosyan93 merged commit fc2e876 into firoorg:master Jun 14, 2024
1 check passed
@AaronFeickert AaronFeickert deleted the linux-docs branch June 14, 2024 14:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Linux build instructions are out of date
3 participants