aboutsummaryrefslogtreecommitdiff
path: root/tools/README.md
diff options
context:
space:
mode:
authorcrueter <crueter@eden-emu.dev>2025-10-05 03:04:53 +0200
committercrueter <crueter@eden-emu.dev>2025-10-05 03:04:53 +0200
commit9f385bf627e40e2b7d5b06cd83cab0a4e9f98f99 (patch)
treea9146b701ca51c941197fe60f90b691ecf60506c /tools/README.md
parent1a13e79c3d8619ff302d9c77eacf1a35c2210b66 (diff)
[tools, cmake] refactor: update/hash check scripts, use tags for some more deps, proper CPMUtil separation (#2666)
Uses tags for a bunch of deps that can use them Also adds a bunmch of scripts to tools/cpm, notably for checking hashes and checking for updates. TODO for the future: - CI target to check hashes - Weekly CI to check for updates Need to get that other CI runner up additional stuff - Ports gentoo fixes - makes solaris work (TODO: sdl2) - way better docs - properly separates CPMUtil as a standalone project Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/2666 Reviewed-by: Lizzie <lizzie@eden-emu.dev> Reviewed-by: MaranBr <maranbr@eden-emu.dev>
Diffstat (limited to 'tools/README.md')
-rw-r--r--tools/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/tools/README.md b/tools/README.md
new file mode 100644
index 0000000000..9abd96175b
--- /dev/null
+++ b/tools/README.md
@@ -0,0 +1,21 @@
+# Tools
+
+Tools for Eden and other subprojects.
+
+## Third-Party
+
+- [CPMUtil Scripts](./cpm)
+
+## Eden
+
+- `shellcheck.sh`: Ensure POSIX compliance (and syntax sanity) for all tools in this directory and subdirectories.
+- `llvmpipe-run.sh`: Sets environment variables needed to run any command (or Eden) with llvmpipe.
+- `optimize-assets.sh`: Optimize PNG assets with OptiPng.
+- `update-cpm.sh`: Updates CPM.cmake to the latest version.
+- `update-icons.sh`: Rebuild all icons (macOS, Windows, bitmaps) based on the master SVG file (`dist/dev.eden_emu.eden.svg`)
+ * Also optimizes the master SVG
+ * Requires: `png2icns` (libicns), ImageMagick, [`svgo`](https://github.com/svg/svgo)
+- `dtrace-tool.sh`
+- `lanczos_gen.c`
+- `clang-format.sh`: Runs `clang-format` on the entire codebase.
+ * Requires: clang