docs: fix RAM requirement formatting - #52
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the README documentation to reflect recent enhancements to the Minecraft server installation scripts, including Java fallback mechanisms, auto-sizing of JVM memory, and improved Bedrock checksum validation.
Key Changes
- Added documentation for UFW installation prerequisite and JVM memory auto-sizing behavior
- Expanded checksum enforcement documentation for Bedrock installer
- Added reference to new Copilot CLI workflow documentation
|
|
||
| For safe simulation workflow details, see **[SIMULATION.md](SIMULATION.md)**. | ||
|
|
||
| > **Simulation CLI:** For step-by-step Copilot CLI workflow, see [COPILOT_RUN_INSTRUCTIONS.md](COPILOT_RUN_INSTRUCTIONS.md). |
There was a problem hiding this comment.
Broken reference: This line references COPILOT_RUN_INSTRUCTIONS.md, but this file does not exist in the repository. Either create the referenced file or remove this line to avoid a broken link.
| The installer auto-sizes memory: `Xms ≈ RAM/4`, `Xmx ≈ RAM/2` (minimums: 1G/2G). You can override these in `/opt/minecraft/start.sh`. | ||
|
|
||
| The installer sets `Xms ≈ RAM/4` and `Xmx ≈ RAM/2` with floors `256M/448M` and an `Xmx` cap of `≤16G`. Override in `/opt/minecraft/start.sh`. | ||
|
|
There was a problem hiding this comment.
Duplicate content: Lines 168 and 170 both describe JVM memory auto-sizing, but with different minimums (1G/2G vs 256M/448M) and different max caps (implied none vs ≤16G). This creates confusion about the actual behavior. Please consolidate into a single, accurate description or remove one of these lines.
| The installer auto-sizes memory: `Xms ≈ RAM/4`, `Xmx ≈ RAM/2` (minimums: 1G/2G). You can override these in `/opt/minecraft/start.sh`. | |
| The installer sets `Xms ≈ RAM/4` and `Xmx ≈ RAM/2` with floors `256M/448M` and an `Xmx` cap of `≤16G`. Override in `/opt/minecraft/start.sh`. | |
| The installer auto-sizes memory: `Xms ≈ RAM/4`, `Xmx ≈ RAM/2` (minimums: 1G/2G, maximum Xmx: 16G). You can override these in `/opt/minecraft/start.sh`. |
|
|
||
| > **Simulation CLI:** For step-by-step Copilot CLI workflow, see [COPILOT_RUN_INSTRUCTIONS.md](COPILOT_RUN_INSTRUCTIONS.md). | ||
|
|
||
| For safe simulation workflow details, see **[SIMULATION.md](SIMULATION.md)**. |
There was a problem hiding this comment.
Duplicate content: Lines 217 and 221 both contain identical references to SIMULATION.md. Remove one of these duplicate lines to avoid redundancy.
| For safe simulation workflow details, see **[SIMULATION.md](SIMULATION.md)**. |
| @@ -210,12 +212,14 @@ If this project saves you time, consider supporting continued maintenance via [B | |||
| - Missing `/run/screen` → follow the "screen socket" section above. | |||
| - Bedrock ZIP MIME-Type issue → revisit the Mojang download page. | |||
|
|
|||
There was a problem hiding this comment.
Missing section header: Line 215 appears to be content that was previously under a "## Contributing" section (visible in the diff at line 214). Without a section header, this line lacks proper context and structure. Consider adding an appropriate section header like "## Contributing" before this line.
| ## Contributing |
Clarify RAM ranges and remove misleading minus signs.