From eeff5a74243915bd07a84630149b2b63ffac5ce0 Mon Sep 17 00:00:00 2001
From: Kae <80987908+Novaenia@users.noreply.github.com>
Date: Fri, 26 Apr 2024 06:57:06 +1000
Subject: [PATCH] Move build instructions into openable sections
[skip ci]
---
README.md | 20 +++++++++++++++-----
1 file changed, 15 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index d21aa73..ff24695 100644
--- a/README.md
+++ b/README.md
@@ -47,7 +47,7 @@ Note: Not every function from [StarExtensions](https://github.com/StarExtensions
Note: Some of these [texts](## "hi :3") are just tooltips rather than links.
-template sbinit.config for dist/ after build
+template sbinit.config for dist/ after build
```json
@@ -63,8 +63,9 @@ Note: Some of these [texts](## "hi :3") are just tooltips rather than links.
```
-
-### Windows
+
+Windows
+
* Install [vcpkg](https://github.com/microsoft/vcpkg?tab=readme-ov-file#quick-start-windows) *globally*.
* vcpkg recommends a short directory, such as `C:\src\vcpkg` or `C:\dev\vcpkg`.
* If you're using Visual Studio, don't forget to run `vcpkg integrate install`!
@@ -76,7 +77,11 @@ Note: Some of these [texts](## "hi :3") are just tooltips rather than links.
* If you're using an IDE, it should detect the correct preset and allow you to build from within.
* Otherwise, build manually by running CMake in the **source/** directory: `cmake --build --preset=windows-release`
* The built binaries will be in **dist/**. Copy the DLLs from **lib/windows/** and the **sbinit.config** above into **dist/** so the game can run.
-### Linux (Ubuntu)
+
+
+
+Linux (Ubuntu)
+
* Make sure you're using CMake 3.19 or newer - you may need to [add Kitware's APT repo](https://apt.kitware.com/) to install a newer version.
* Install dependencies:
* `sudo apt-get install pkg-config libxmu-dev libxi-dev libgl-dev libglu1-mesa-dev libsdl2-dev python3-jinja2 ninja-build`
@@ -87,8 +92,11 @@ Note: Some of these [texts](## "hi :3") are just tooltips rather than links.
* The built binaries will be in **dist/**. Copy the the .so libs from **lib/linux/** and the **sbinit.config** above into **dist/** so the game can run.
* From the root dir of the repo, you can run the assembly script which is used by the GitHub Action: `scripts/ci/linux/assemble.sh`
* This packs the game assets and copies the built binaries, premade sbinit configs & required libs into **client/** & **server/**.
+
+
-### Linux (Fedora)
+
+Linux (Fedora)
Starbound in general is built from the ground up, with its own engine written in C++ on top of some basic libraries.
@@ -170,5 +178,7 @@ LD_LIBRARY_PATH="$LD_LIBRARY_PATH:./" padsp ./starbound "$@"`
+
+
### macOS
To be written.