From 30e450731744730edf5c12265da35eef366f17e7 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Date: Thu, 22 Aug 2024 02:02:37 -0400 Subject: [PATCH] Update readme --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 429a570..32299dd 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,29 @@ Everything in here is a little sample program or otherwise which uses [haloo3d](https://github.com/randomouscrap98/haloo3d) and -[unigi](https://git.lumen.sh/Fierelier/unigi). +[unigi](https://git.lumen.sh/Fierelier/unigi). It's all software +rendered, but you'll need to get sdl1 so it can render to screen. The libraries required are set as submodules, so you can pull them -with: +when cloning with: + +``` +git clone --recurse-submodules +``` + +Or if you already cloned, you can do this after the fact: ``` git submodule update --init ``` -You don't need to pull in the submodules if you setup your includes -and stuff. +Then, to build any example, just do `make name.exe`. For example, to +build maze.c, you would do + +``` +make maze.exe +./maze.exe +``` ## Unigi