diff --git a/README.md b/README.md new file mode 100644 index 0000000..ad5e59c --- /dev/null +++ b/README.md @@ -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. +