From 8b2ab62640678f1992a93527fe4f6098614dcf75 Mon Sep 17 00:00:00 2001 From: Jaby Date: Tue, 31 Dec 2024 19:54:44 +0100 Subject: [PATCH] Update readme again --- readme.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index bb0ea2eb..70c32237 100644 --- a/readme.md +++ b/readme.md @@ -1,7 +1,10 @@ - [JabyEngine](#jabyengine) - [About](#about) - [How to build](#how-to-build) - - [Building JabyEngine (without VSCode)](#building-jabyengine-without-vscode) + - [Building `JabyEngine` (without VSCode)](#building-jabyengine-without-vscode) + - [Building support library (without VSCode)](#building-support-library-without-vscode) + - [`FontWriter` (without VSCode)](#fontwriter-without-vscode) + - [Building `PoolBox` (without VSCode)](#building-poolbox-without-vscode) - [Media creators](#media-creators) - [JabyEngine](#jabyengine-1) - [PoolBox](#poolbox) @@ -18,12 +21,27 @@ The following environment variables should be set: * `JABY_ENGINE_PATH`: The path to the root folder of this repo * `PSX_LICENSE_PATH`: The path to a folder containing the PS1 licenses for generating a CD. -### Building JabyEngine (without VSCode) +### Building `JabyEngine` (without VSCode) `make` requires the following values to be passed: * `BUILD_PROFILE`: `debug`/`release` * `PSX_TV_FORMAT`: `PAL`/`NTSC` * `CUSTOM_CONFIG`: Empty or folder name under `./config` +### Building support library (without VSCode) +These projects shall eventually turn into useful extensions for the engine. So far they are more tests then proper code. However `PoolBox` is depended on `FontWriter`. + +#### `FontWriter` (without VSCode) +`make` requires the following values to be passed: +* `BUILD_PROFILE`: `debug`/`release` + +### Building `PoolBox` (without VSCode) +`PoolBox` is the one and only example project so far. +`make` requires the following values to be passed: +* `BUILD_PROFILE`: `debug`/`release` +* `REGION`: `SCEE`/`SCEA`/`SCEI` +* `CUSTOM_CONFIG`: Empty or folder name under `$(JABY_ENGINE_PATH)/config` + + # Media creators ## JabyEngine | Art | Author |