Updates to readmes

This commit is contained in:
2024-07-01 12:23:55 -04:00
parent 10f1f7655c
commit f02a5c0783
2 changed files with 47 additions and 7 deletions

36
scripts/Readme.md Normal file
View File

@@ -0,0 +1,36 @@
# Scripts
All scripts provided for utilizing the example demos or backends.
## General
### build_sokol_demo.ps1
Builds example's sokol_demo.odin. Will gather necessary dependencies first.
### build_sokol_library.ps1
Helper script used by `build_sokol_demo.ps1`. Build's & modifies the library for its use in the examples.
### clean.ps1
Will wipe the build folder.
### compile_sokol_shaders.ps1
Will generate the odin files containing the sokol shader descriptions for the corresponding glsl shaders. Utilized by the sokol backend. Doesn't need to be runned unless modifications are made to the shaders (pre-generated files are commited to this repository).
## Helpers
### devshell.ps1
Will run `Launch-VsDevShell.ps1` for the user to populate the shell with its enviornmental definitions
### misc.ps1
A few helper functions to utilize powerhsell & github repos as package management.
### odin_compiler_defs.ps1
Just variable declarations based on flags used with the odin compiler's CLI.