diff options
Diffstat (limited to 'misc/readme.md')
| -rw-r--r-- | misc/readme.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/misc/readme.md b/misc/readme.md new file mode 100644 index 0000000..56f5358 --- /dev/null +++ b/misc/readme.md @@ -0,0 +1,19 @@ +This folder contains additional files and resources for ClassiCube + +## Icons + +CCicon.ico is the basis icon for the other icon files + +Generating icons that can be embedded in the executable is operating system and compiler specific - see the relevant operating system folder for more details + +TODO: Explain how to compile your own icon for all the platforms + +## Folder meanings + +|File|Description| +|--------|-------| +|windows | Contains icons | +|macOS | Contains icons, Info.plist for generating macOS Application Bundle | +|linux | Contains icons, script for generating a Desktop Entry | +|xbox | Contains Xbox shaders | +|build_scripts | Contains scripts for compiling plugins and optimised ClassiCube executables| \ No newline at end of file |