From e247bb8a72f17e1a9b882d0dac8570783a8b4a5c Mon Sep 17 00:00:00 2001 From: 0XC7R <0xC7R@proton.me> Date: Sat, 7 Mar 2026 11:35:31 +0000 Subject: [PATCH] Revise README sections and formatting Updated README to improve clarity and organization of sections. --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2cd1734..57130d5 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,23 @@ Hello, I made this project for fun. +---- + +[Using Docker](#Using-Docker) +[Prod Packages](#Using-Production-packages-(Windows)) + +---- + +## Using-Docker + +*Please keep in mind you should run docker with nessesary perms, have access to the internet and actually have docker installed. +Install-Debian-Linux(GIVE ME SUDO).sh is a good start point* + Just use docker please the src is fine to use as well but you need golang, bun, garble and openssl. To use docker copy the docker-compose.yml to your working directory and run + ```sh docker compose up ``` @@ -37,7 +50,7 @@ docker compose pull It's literally just docker any question chatgpt can answer so don't worry. -## Production package (Windows) +## Using-Production-packages-(Windows) Build a production-ready package where the server can still build client binaries at runtime: @@ -67,4 +80,4 @@ Windows package includes: `build-prod-package.bat` also minifies `public/assets/*.js` into the release package. -Note: both packaging scripts always skip building client binaries and export `Overlord-Client` source for runtime builds. \ No newline at end of file +Note: both packaging scripts always skip building client binaries and export `Overlord-Client` source for runtime builds.