chore: update readme#6878
Conversation
WalkthroughThe README instructions have been updated to reflect changes in test command usage, service startup, and mining configurations. The test command now requires the nightly version of Cargo, and the macOS Darwin kernel note for RandomX unit tests has been removed. Instructions for starting the Tor service and for launching Tari applications have been simplified. Additionally, the mining protocol's apportionment has been changed from a 40/60 to a 50/50 split, and several MiningCore configuration sections have been removed. Changes
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
276-283: Clarify Running Mode Examples
The new "Running+:" section and the subsequent note about omitting the--releaseflag for debug mode are helpful. However, the sample commands still include--release, which might confuse readers about how to run in debug mode. It may be worth either providing a separate example for debug mode (without the--releaseflag) or clarifying the intent if the examples are meant only for release builds.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
278-278: Code block style
Expected: fenced; Actual: indented(MD046, code-block-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(6 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: test (nextnet, nextnet)
- GitHub Check: cargo check with stable
- GitHub Check: Cucumber tests / Base Layer
- GitHub Check: ci
🔇 Additional comments (3)
README.md (3)
41-41: Update Test Command Syntax
The change to usecargo +nightly ci-testis correct and clearly communicates that the nightly version of Cargo is required for running tests.
273-274: Simplified Tor Service Instructions
The updated instructions now tell Windows users to "start the Tor service" using a specific shortcut and note that for Linux/Mac the Tor service is included in the binary. This simplification improves clarity. Consider double-checking that users on Linux/Mac understand they do not need to start Tor manually.
376-377: Updated Mining Apportionment Details
The updated text now reflects the new 50/50 split for standalone/pooled SHA3 mining versus Monero merged mining, which aligns with the consensus rules change.
Test Results (CI) 3 files 129 suites 45m 29s ⏱️ Results for commit 106a917. |
Test Results (Integration tests)36 tests 36 ✅ 16m 31s ⏱️ Results for commit 106a917. |
* development: (412 commits) chore: new release v1.13.1-pre.0 (tari-project#6898) fix: excess sig order in the tx tab (tari-project#6897) chore: ensure thread safety (tari-project#6896) fix: peer order (tari-project#6894) fix: use plain string for grpc address (tari-project#6881) fix: startup arg (tari-project#6889) feat: add num connections to network state (tari-project#6884) refactor: reduce logging to make it less noisy (tari-project#6882) feat: check coinbase count (tari-project#6880) chore(deps): bump dorny/test-reporter from 1 to 2 (tari-project#6883) chore: update readme (tari-project#6878) fix: libtor cli option (tari-project#6877) chore: new version v1.13.0-pre.0 (tari-project#6875) chore: reset network (tari-project#6874) fix: prune mode validation (tari-project#6873) perf: remove duplicate metadata signature verification (tari-project#6866) feat: remove static moneroD response (tari-project#6867) chore(ci): updates to pull version from workspace (tari-project#6868) chore(ci): binaries build continue-on-error when release (tari-project#6865) chore: handle seed words env var (tari-project#6855) ...
2 participants
Description
Removes old and wrong content in the readme
Summary by CodeRabbit