Akkariin/eggs
1
0
Fork 0
mirror of https://github.com/parkervcp/eggs.git synced 2024-11-29 18:58:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2267 from diedyesterdaywashere/readme-specs

Browse Source 
Add a template for Installation/System Requirements in example README
This commit is contained in:
Michael (Parker) Parker 2023-07-06 21:50:50 -04:00 committed by GitHub
commit 2486d6f0d9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
example/README.md
View File

@ -18,17 +18,15 @@ The description of the server usually provided by the game/server maker.
<!--Make a note if the user needs to get any keys or other items to run/use the server--> <!--Make a note if the user needs to get any keys or other items to run/use the server-->
Due to rate limiting the console on the panel, it cannot keep up with the game console and the build will complete before the panel console may show it. Reloading the console will load it to the latest part of the log. Due to rate limiting the console on the panel, it cannot keep up with the game console and the build will complete before the panel console may show it. Reloading the console will load it to the latest part of the log.
## Minimum RAM warning ## Installation/System Requirements
<!--Make changes to reflect the server minimum/recommended hardware specs-->
Minimum required memory to run the server. | | Bare Minimum | Recommended |
<!--Example: 2GB is recommended. 4GB+ is preferred--> |---------|---------|---------|
| Processor | *Main info (32/64 bit or ARM support)* | *More info about egg's preferred processor* |
## Minumim Sorage warning | RAM | *Minimum amount of RAM (in MiB/GiB)* | *Recommended amount of RAM (in MiB/GiB)* |
| Storage | *Minimum amount of Storage (in MiB/GiB)* | *Recommended amount of Storage (in MiB/GiB)* |
Minimum required storage to run the server. | Network | *Minimum network speed (in Mbit/s)* | *Recommended network speed (in Mbit/s)* |
<!--Example: 10GB is recommended. 25GB+ is preferred--> | Game Ownership | *Can the server start without it?* | *Is it needed for any other features?* |
<!--Make a note if the install script would require more then the above amounts-->
## Server Ports ## Server Ports