Added Requiremnts to Readme

This commit is contained in:
Andrei Stoica 2020-04-22 18:35:37 -04:00 committed by GitHub
parent f8cecdc00c
commit f4e1192748
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 1 deletions

View File

@ -2,6 +2,17 @@
This is a all in one setup to run a Spigot server using docker. It also includes
a systemd unit file for setting it up to run automaticaly.
## Requirements
- docker
- make
- curl
The server is configured to use up to 4 GB if ram. To change this you will need to edit the docker run commands in the Makefile and unit file.
> -Xms1G
- minimum 1 GB of memory
> -Xmx4G
- maximum 4 GB of memeory
## Building
> make build-latest
- builds the latest version of of spigot
@ -24,4 +35,3 @@ a systemd unit file for setting it up to run automaticaly.
> make down
- top the systemd service