vxaboveground/overlord
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Revise README sections and formatting

Browse Source 
Updated README to improve clarity and organization of sections.
This commit is contained in:
0XC7R
2026-03-07 11:35:31 +00:00
committed by GitHub
parent c735ac95c3
commit e247bb8a72
1 changed files with 15 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+15 -2
View File
@@ -8,10 +8,23 @@
Hello, I made this project for fun. 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. 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 To use docker copy the docker-compose.yml to your working directory and run
```sh ```sh
docker compose up docker compose up
``` ```
@@ -37,7 +50,7 @@ docker compose pull
It's literally just docker any question chatgpt can answer so don't worry. 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: 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. `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. Note: both packaging scripts always skip building client binaries and export `Overlord-Client` source for runtime builds.