From 1bc6cb80d297d4ae4afd1d81f65f363815a7be7e Mon Sep 17 00:00:00 2001
From: Erlend <49862976+Erb3@users.noreply.github.com>
Date: Sun, 7 Aug 2022 10:21:38 +0200
Subject: [PATCH] Improved README + Changelog
---
CHANGELOG.md | 23 +++++++++++++++++++++++
README.md | 41 ++++++-----------------------------------
2 files changed, 29 insertions(+), 35 deletions(-)
create mode 100644 CHANGELOG.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..f8478bc
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,23 @@
+# Changelog
+
+#### v. 1.5:
+- You can now mirror a frame to a monitor by using :setMirror(side)
+- with dynamic values you are able to use percentage values and even functions which get called everytime we need the size of that object
+- XML got added to make design and logic seperate (you don't have to) - you are now able to use xml to create your UI design.
+- Animations are now more advanced and provide many features to do cool stuff. They are also very easy to use now!
+- Also some smaller bugfixes
+- new bugs to explore
+- fixed monitor support
+- added :setIndex() for scrollbars
+- added dynamic value system (not fully done)
+- reworked the filesystem, now we use require instead of loadfile
+- from now on the single file will be complied on the end users computer
+- prepared everything for an advanced installer
+
+#### v. 1:
+- created Basalt
+- added many objects (buttons, checkbox, labels, programs, switch, radio, lists, dropdowns, input, textfields, images, menubar, animations, threads, timers, progressbar, scrollbar, slider, pane)
+- added bigfont
+- added blittle
+- added coroutine management
+- added advanced event system
diff --git a/README.md b/README.md
index ba01819..a284929 100644
--- a/README.md
+++ b/README.md
@@ -1,39 +1,10 @@
# Basalt - A UI Framework for CC:Tweaked
-Basalt is still under developement and you may find bugs!
+Basalt is intended to be an easy-to-understand UI Framework designed for CC:Tweaked (Also know as "ComputerCraft: Tweaked") - a popular minecraft mod. For more information about CC:Tweaked, checkout the project's [wiki](https://tweaked.cc/) or [download](https://www.curseforge.com/minecraft/mc-mods/cc-tweaked).
+**Note:** Basalt is still under developement and you may find bugs!
-## Information
-
-Check out the [wiki](https://basalt.madefor.cc/) for information
-If you have questions, feel free to join the discord server: [https://discord.gg/yM7kndJdJJ](https://discord.gg/yM7kndJdJJ)
-
-## Changelogs
-From now on we will add changes:
-
-#### Version 4:
-- You can now mirror a frame to a monitor by using :setMirror(side)
-- with dynamic values you are able to use percentage values and even functions which get called everytime we need the size of that object
-- XML got added to make design and logic seperate (you don't have to) - you are now able to use xml to create your UI design.
-- Animations are now more advanced and provide many features to do cool stuff. They are also very easy to use now!
-- Also some smaller bugfixes
-- new bugs to explore
-
-#### Version 3:
-- fixed monitor support
-- added :setIndex() for scrollbars
-- added dynamic value system (not fully done)
-
-#### Version 2:
-Note: You won't get any changes for now, so don't redownload the project! (:
-- reworked the filesystem, now we use require instead of loadfile
-- from now on the single file will be complied on the end users computer
-- prepared everything for an advanced installer
-
-#### Version 1:
-- created Basalt
-- added many objects (buttons, checkbox, labels, programs, switch, radio, lists, dropdowns, input, textfields, images, menubar, animations, threads, timers, progressbar, scrollbar, slider, pane)
-- added bigfont
-- added blittle
-- added coroutine management
-- added advanced event system
+Check out the [wiki](https://basalt.madefor.cc/) for more information.
+If you have questions, feel free to join the discord server: [https://discord.gg/yNNnmBVBpE](https://discord.gg/yNNnmBVBpE).
+## Demo
+
\ No newline at end of file