diff --git a/README.md b/README.md index 7af07ed..c99543a 100644 --- a/README.md +++ b/README.md @@ -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
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.

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 -
-(optional) replace `` 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 `` 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 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")