From d599397bd8e84226c0ab285c3cf46cbb0750e4af Mon Sep 17 00:00:00 2001
From: /nick haya <74699483+The-SGPT@users.noreply.github.com>
Date: Sun, 20 Feb 2022 11:03:12 +0800
Subject: [PATCH] new stuff unreleated to code

---
 CHANGELOG.md     | 16 ++++++++++++++++
 DOCUMENTATION.md | 36 ++++++++++++++----------------------
 README.md        |  4 ++--
 3 files changed, 32 insertions(+), 24 deletions(-)
 create mode 100644 CHANGELOG.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..3d6a1f9
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,16 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+### Added
+- `EVERYTHING.`
+- Proper readme :)
+- Added basic LuaJIT support, thanks sol3!
+- Initial changelog creation
+
+### Removed
+- BASS and BASS_fx support.
+- `.MID` support due to crashes. (God dammit SoLoud)
\ No newline at end of file
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
index 28ffb76..d8c153d 100644
--- a/DOCUMENTATION.md
+++ b/DOCUMENTATION.md
@@ -1,4 +1,4 @@
-# What the shit is this
+# 🤨
 
 A wrapper build around SDL2, some of its libraries, and SoLoud to make a lot of stuff
 more easier to use.
@@ -9,33 +9,25 @@ Stuff like:
 - Object system
 - Sound
 - Configuration
-- and most possibly, more.... idk.
 - Less dll binary clutter!
+- and most possibly, more.... idk.
 
-## How the shit to use it den
+## Requirements
 
-Currently, it only supports MSVC, but you could probably tweak CMakeLists.txt to be able to use
-MingW, or GCC.
+- [CMake](https://cmake.org) version 3.10 or above
+- [SDL2 and SDL_ttf 2.0](https://libsdl.org)
+- [SDL_gpu](https://github.com/grimfang4/sdl-gpu)
+- [SoLoud](https://github.com/haya3218/soloud) (static library)
+- [LuaJIT](http://luajit.org)
 
-### Requirements
+### Compiler Requirements
 
-- CMake, to build the damn thing
-- SDL2 and SDL_ttf 2.0, duh
-- SoLoud (static library)
-- A VC++ (MSVC) compiler that atleast supports C++ std 17
+- VC++ (MSVC) version 14.2 or above
+(GCC, clang, and MingW-w64 are not supported yet, [but feel free to make a pull request!](https://github.com/haya3218/SDfmL/compare))
 
-To use it (in windows atleast),
+#### Instructions
 
-- Get SDL2 and SDL_ttf 2.0, and put em on the respective x86 and x64 folders.
-You know how to place them. It's fucking common sense.
-- Get SDL_gpu as well.
-- [SoLoud fork.](https://github.com/haya3218/soloud) Follow GENie instructions and build as a static library.
-- You also need to build libmodplug with it as well.
-- If you are gonna be using the OpenMPT module, you'll need the libopenmpt dll in your exe directory as well.
-- Prebuilt binaries (with OpenMPT) are [here.](https://cdn.discordapp.com/attachments/872338952483381258/943307934258057267/SoLoud-SDL2_gpu-libmodplug.7z)
-- Clone the dam repo somewhere on ur machine.
-- Go to where you cloned it, and run `cmake -B build -DCMAKE_BUILD_TYPE=Release`
-- After successfully making the build files, run `cmake --build --config Release` to build it without the use of VStudio.
-- If everything worked well, congratulations! You have just compiled a shitty program.
+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.
diff --git a/README.md b/README.md
index 51334da..b3cdb7a 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,6 @@ Uses a style based on Flixel, a (very old) flash game engine.
 
 *This branch is experimental, think before you use!*
 
-*For more information, check out [the basics.](DOCUMENTATION.md)*
+*For more information, check out the [[DOCUMENTATION]].*
 
-*License details are at [LICENSING.md](LICENSING.md)*
+*License details are at [[LICENSING]].*