joseph-aquino/imgui-sfml-premake
joseph-aquino
/
imgui-sfml-premake
mirror of https://gitlab.com/JosephA1997/imgui-sfml-premake.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Edit README.md

This commit is contained in:
Joseph Aquino 2026-04-05 05:08:18 +00:00
parent 341153ea7d
commit 22b9d44810
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -1,18 +1,17 @@
# Easily add [SFML 3](https://github.com/SFML/SFML) and [Dear ImGui](https://github.com/ocornut/imgui) to your premake5 projects
<br> This repo contains the repositories for SFML, Dear ImGui, sfml-imgui, flac, vorbis, ogg, and freetype along with premake build scripts.
This allows your project to build these libraries from source and statically link them to your executible.
this makes developing on linux easier as most distros don't have SFML 3 in their package managers.
This makes developing on linux easier as most distros don't have SFML 3 in their package managers.
<br><br> I have included `example-project.txt` and `example-workspace.txt` as examples on how to use this project
## How to integrate into your projects
1. Add the repository as a submodule and update its submodules
<br> -(optional) replace `<directory-path>` with the path to the directory you want the repo to be cloned to,
1. Add the repository as a submodule and update its submodules. Replace `<directory-path>` with the path to the directory you want the repo to be cloned to,
leaving this out will place this repo into `./imgui-sfml-premake`
```
git submodule add https://gitlab.com/JosephA1997/imgui-sfml-premake.git <directory-path>
git submodule update --init --recursive
```
2. Add this to the top of the script that contains the workspace, replace 'path/to' with the directory that you cloned this repo to
2. Add this to the top of the lua file that contains the workspace, replace 'path/to' with the directory that you cloned this repo to
```lua
local ogg = require("path/to/premake-scripts/build-ogg")
local imgui = require("path/to/premake-scripts/build-imgui")