$Project = "C:\Users\omega\Documents\tools\Samurai-Shodown-Warriors-Rage-Recomp"
Set-Location $Project

@'
# Samurai Shodown: Warriors Rage Recomp

A native PlayStation recompilation of **Samurai Shodown: Warriors Rage** (USA), built with [mstan's PSXRecomp](https://github.com/mstan/psxrecomp).

## Status

The game is currently playable on Windows with the updated `recomp-ui` launcher and setup menu.

- Game ID: `SLUS-01039`
- Region: USA
- Players: 2
- Renderer: OpenGL
- Controller: Digital

## Requirements

- Windows 10 or newer
- Git
- CMake
- Ninja
- Python 3
- Compatible Clang or MinGW toolchain
- Your own legally obtained game dump

## Legal Notice

This repository contains source code and configuration only. It does not include ROMs, BIN/CUE files, BIOS files, generated game data, executables, DLLs, or build folders.

You must provide your own legally obtained copy of the game.

Samurai Shodown and related properties belong to SNK and their respective rights holders. This is an unofficial fan project and is not affiliated with or endorsed by SNK, Sony, or the original developers.

## Project Structure

- `game.toml` — game configuration
- `symbols.toml` — symbol definitions
- `seeds/ghidra_funcs.txt` — discovered function seeds
- `codegen_setup.c` — code-generation setup
- `psxrecomp/` — PSXRecomp framework submodule
- `recomp-ui/` — launcher UI submodule

## Credits

- [mstan](https://github.com/mstan) and PSXRecomp contributors
- The recomp-ui contributors
- SNK and the original Samurai Shodown: Warriors Rage development team

## License

See [LICENSE](LICENSE). Third-party submodules retain their respective licenses.
'@ | Set-Content -Path ".\README.md" -Encoding UTF8

git add README.md
git commit -m "Add project README"
git push