csmith1865/ping-server
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md
Some checks failed
Go / build (push) Has been cancelled
Details

Browse Source
This commit is contained in:
Carlton Smith
2025-01-16 04:34:07 +00:00
parent 68fc956432
commit a085badb51
1 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -20,19 +20,22 @@ https://mcstatus.io/docs
## Getting Started ## Getting Started
```bash ```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 $ 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 $ cd ping-server
# 3. Run the build script # 5. Run the build script
$ make $ make
# 4. Copy the `config.example.yml` file to `config.yml` and modify details as needed # 6. Start the development server
$ cp config.example.yml config.yml
# 5. Start the development server
$ ./bin/main $ ./bin/main
# The server will be listening on http://localhost:3001 (default host + port) # The server will be listening on http://localhost:3001 (default host + port)