From b638b2c2238aeeee3cc7862af20c19825b248d67 Mon Sep 17 00:00:00 2001 From: Romain BOULLARD Date: Wed, 28 Jan 2026 18:26:04 +0000 Subject: [PATCH] Update README (#4) Reviewed-on: https://git.romainboullard.com/BigfootDev/Bigfoot/pulls/4 Co-authored-by: Romain BOULLARD Co-committed-by: Romain BOULLARD --- README.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index ec83174..5a66607 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,9 @@ The goal is to build a multiplatform, API agnostic, 3D engine. Since this is a l ### Requirements 1. [ConanV2](https://conan.io/) -2. [SQLite3 tools](https://www.sqlite.org/download.html) available from the command line 3. [Vulkan SDK](https://www.lunarg.com/vulkan-sdk/) (If you target Vulkan) 4. [CMake](https://cmake.org/) 5. [Git](https://git-scm.com/) -6. [RenderDoc](https://renderdoc.org/) (If you want to use the integrated RenderDoc API) 7. [Python3](https://www.python.org/) #### Additional requirements for Linux @@ -50,16 +48,14 @@ You can customize these scripts to opt-out of some Bigfoot features 'Just' modify these lines to disable them (I promise to one day modify the script to do it from the command line) ``` -bigfoot/*:unity_build=True -o bigfoot/*:build_tests=True -o bigfoot/*:tracy=True -o bigfoot/*:build_tools=True -o bigfoot/*:vulkan=True -o bigfoot/*:build_benchmarks=True -o bigfoot/*:render_doc=True +-o bigfoot/*:build_tests=True -o bigfoot/*:tracy=True -o bigfoot/*:build_tools=True -o bigfoot/*:vulkan=True -o bigfoot/*:build_benchmarks=True ``` -1. unity_build: Enable/Disable [unity builds](https://cmake.org/cmake/help/latest/variable/CMAKE_UNITY_BUILD.html) feature (will slow down compilation times) -2. build_tests: Enable/Disable the tests -3. tracy: Enable/Disable profiling using [Tracy](https://github.com/wolfpld/tracy) -4. build_tools: Enable/Disable the tools (I'd absolutely recommand not disabling this if you are building benchamrks or tests) -5. vulkan: Enable/Disable Vulkan renderer (No point disabling it, since for now only Vulkan is available in Bigfoot) -6. build_benchmarks: Enable/Disable the benchmarks -7. render_doc: Enable/Disable the possitbility to use [RenderDoc](https://renderdoc.org/) API to capture from code +1. build_tests: Enable/Disable the tests +2. tracy: Enable/Disable profiling using [Tracy](https://github.com/wolfpld/tracy) +3. build_tools: Enable/Disable the tools (I'd absolutely recommand not disabling this) +4. vulkan: Enable/Disable Vulkan renderer (No point disabling it, since for now only Vulkan is available in Bigfoot) +5. build_benchmarks: Enable/Disable the benchmarks ### Generating Bigfoot