From 0f89cf77d022e9aa0afb3728fe9c8d467817ae7d Mon Sep 17 00:00:00 2001 From: /nick haya <74699483+The-SGPT@users.noreply.github.com> Date: Sun, 20 Feb 2022 14:10:56 +0800 Subject: [PATCH] make it more clear --- DOCUMENTATION.md | 6 ++++++ LICENSING.md | 10 +++++----- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 46740b0..ed6d4e1 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -31,3 +31,9 @@ Copy all of the library files to the `lib/` folder. Reminder that ALL header files are already included, so you don't need to worry about linker issues. `src/Main.cpp` should contain example code with some explanations. + +Run `cmake` in any kind of way to build the program (most recommended is `cmake -B build -DCMAKE_BUILD_TYPE=Release -G "NMake Makefiles"`) and give yourself a pat in the back for building it. + +## Documentation? + +Not now. Most likely when the framework actually reaches a stable 1.0 release. diff --git a/LICENSING.md b/LICENSING.md index 68da5c6..4c941d5 100644 --- a/LICENSING.md +++ b/LICENSING.md @@ -1,10 +1,10 @@ # Licensing -The sole libraries themselves (SDL, SoLoud) are under the zLib/LibPNG licenses ofc, so you'll have to deal with that - -stb_image is under the Public Domain/MIT. - -TinySoundfont and toml11 are under the MIT License. +- Framework itself - see below ;) +- SDL2, SDL_ttf and SoLoud - zlib/libPNG +- TinySoundfont, toml11, Lua, LuaJIT, sol2 - MIT License +- argh - BSD-3 +- stb_image.h - Public Domain/MIT ## SDfmL license