aboutsummaryrefslogtreecommitdiff
path: root/tools/README.md
diff options
context:
space:
mode:
authorlizzie <lizzie@eden-emu.dev>2025-10-20 14:25:03 +0200
committercrueter <crueter@eden-emu.dev>2025-10-20 14:25:03 +0200
commit226160f6398789087ad6f01d660608c701b3cce8 (patch)
tree8e3609c5fb4a6107845565647dac9738699be023 /tools/README.md
parent0eeeee515e8c8c533b8514b2bbaf7f2d17e93341 (diff)
[docs, tools] Add 3rd party links, debug and testing guidelines; add extra tools for maintaining strings, rewrite lanczos generator in perl (#2749)
RenderDoc checklist inspired by writeup of Charles G. of LunarG Signed-off-by: lizzie <lizzie@eden-emu.dev> Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/2749 Reviewed-by: MaranBr <maranbr@eden-emu.dev> Co-authored-by: lizzie <lizzie@eden-emu.dev> Co-committed-by: lizzie <lizzie@eden-emu.dev>
Diffstat (limited to 'tools/README.md')
-rw-r--r--tools/README.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/tools/README.md b/tools/README.md
index 061e95bc9c..55eeba898a 100644
--- a/tools/README.md
+++ b/tools/README.md
@@ -11,15 +11,16 @@ Tools for Eden and other subprojects.
- `find-unused-strings.pl`: Find unused strings (for Android XML files).
- `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.
+- `optimize-assets.sh`: Optimizes 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`
+- `lanczos-gen.pl`: Generates constants for the Lanczos filter.
- `clang-format.sh`: Runs `clang-format` on the entire codebase.
* Requires: clang
+- `find-unused-strings.sh`: Find any unused strings in the Android app (XML -> Kotlin).
## Android
It's recommended to run these scritps after almost any Android change, as they are relatively fast and important both for APK bloat and CI.
@@ -29,4 +30,4 @@ It's recommended to run these scritps after almost any Android change, as they a
## Translations
-- [Translation Scripts](./translations) \ No newline at end of file
+- [Translation Scripts](./translations)