diff --git a/README.md b/README.md index a24b181..4be9e25 100644 --- a/README.md +++ b/README.md @@ -20,19 +20,22 @@ https://mcstatus.io/docs ## Getting Started ```bash -# 1. Clone the repository (or download from this page) +# 1. Update repository +$ sudo apt update + +# 2. Install GO +$ sudo apt install -y golang-go redis-tools make + +# 3. Clone the repository (or download from this page) $ git clone https://git.sumisu.xyz/csmith1865/ping-server.git -# 2. Move the working directory into the cloned repository +# 4. Move the working directory into the cloned repository $ cd ping-server -# 3. Run the build script +# 5. Run the build script $ make -# 4. Copy the `config.example.yml` file to `config.yml` and modify details as needed -$ cp config.example.yml config.yml - -# 5. Start the development server +# 6. Start the development server $ ./bin/main # The server will be listening on http://localhost:3001 (default host + port)