feat: added README.md

This commit is contained in:
Sara Gerretsen 2025-09-04 11:25:39 +02:00
parent a895e34ce7
commit 8e3f272122

14
README.md Normal file
View file

@ -0,0 +1,14 @@
# IMGUI-SFML template
# Usage:
Clone this repository and enter.
Run `just set-project-name {name}` in the project root directory.
> Note: {name} will be the name of your binary.
(Optional, but recommended) Commit changes to git.
Run `just generate` and `just build`, this should output a binary named {name} (as given for `set-project-name`) in the `bin/` subdirectory of the project root.