From 5d40d295b3c98023914d736be2d3bc766bf4ba1c Mon Sep 17 00:00:00 2001 From: omar Date: Fri, 31 Aug 2018 11:33:12 +0200 Subject: [PATCH] Comments, readme updates --- docs/CHANGELOG.txt | 4 ++-- examples/README.txt | 7 ++++--- imgui.cpp | 5 ++++- 3 files changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/CHANGELOG.txt b/docs/CHANGELOG.txt index 73ed9747..b3156adb 100644 --- a/docs/CHANGELOG.txt +++ b/docs/CHANGELOG.txt @@ -38,8 +38,8 @@ Changes: - Moved README, CHANGELOG and TODO files to the docs/ folder. If you are updating dear imgui by copying files, take the chance to delete the old files. - Added imgui_widgets.cpp file, extracted and moved widgets code out of imgui.cpp into imgui_widgets.cpp. - Re-ordered some of the code remaining in imgui.cpp in cleared chunks. - NONE OF THE FUNCTIONS HAVE CHANGED. THE CODE IS SEMANTICALLY 100% IDENTICAL, BUT ALL FUNCTIONS WERE MOVED. + Re-ordered some of the code remaining in imgui.cpp. + NONE OF THE FUNCTIONS HAVE CHANGED. THE CODE IS SEMANTICALLY 100% IDENTICAL, BUT _EVERY_ FUNCTIONS HAS BEEN MOVED. Because of this, any local modifications to imgui.cpp will likely conflict when you update. If you have any modifications to imgui.cpp, it is suggested that you first update to 1.63, then isolate your patches. You can peak at imgui_widgets.cpp from 1.64 to get a sense of what is included in it, diff --git a/examples/README.txt b/examples/README.txt index e5764250..a3fb441c 100644 --- a/examples/README.txt +++ b/examples/README.txt @@ -1,6 +1,7 @@ ---------------------------------------- - README FIRST ---------------------------------------- +----------------------------------------------------------------------- + examples/README.txt + (This is the README file for the examples/ folder. See docs/ for more documentation) +----------------------------------------------------------------------- Dear ImGui is highly portable and only requires a few things to run and render: diff --git a/imgui.cpp b/imgui.cpp index 28b986a8..2fa7e0a9 100644 --- a/imgui.cpp +++ b/imgui.cpp @@ -333,6 +333,9 @@ CODE When you are not sure about a old symbol or function name, try using the Search/Find function of your IDE to look for comments or references in all imgui files. You can read releases logs https://github.com/ocornut/imgui/releases for more details. + - 2018/08/31 (1.64) - added imgui_widgets.cpp file, extracted and moved widgets code out of imgui.cpp into imgui_widgets.cpp. Re-ordered some of the code remaining in imgui.cpp. + NONE OF THE FUNCTIONS HAVE CHANGED. THE CODE IS SEMANTICALLY 100% IDENTICAL, BUT _EVERY_ FUNCTION HAS BEEN MOVED. + Because of this, any local modifications to imgui.cpp will likely conflict when you update. Read docs/CHANGELOG.txt for suggestions. - 2018/08/22 (1.63) - renamed IsItemDeactivatedAfterChange() to IsItemDeactivatedAfterEdit() for consistency with new IsItemEdited() API. Kept redirection function (will obsolete soonish as IsItemDeactivatedAfterChange() is very recent). - 2018/08/21 (1.63) - renamed ImGuiTextEditCallback to ImGuiInputTextCallback, ImGuiTextEditCallbackData to ImGuiInputTextCallbackData for consistency. Kept redirection types (will obsolete). - 2018/08/21 (1.63) - removed ImGuiInputTextCallbackData::ReadOnly since it is a duplication of (ImGuiInputTextCallbackData::Flags & ImGuiInputTextFlags_ReadOnly). @@ -804,7 +807,7 @@ CODE Rectangles provided by ImGui are defined as (x1=left,y1=top,x2=right,y2=bottom) and NOT as (x1,y1,width,height). Q: How can I help? - A: - If you are experienced with Dear ImGui and C++, look at the github issues, or TODO.txt and see how you want/can help! + A: - If you are experienced with Dear ImGui and C++, look at the github issues, or docs/TODO.txt and see how you want/can help! - Convince your company to fund development time! Individual users: you can also become a Patron (patreon.com/imgui) or donate on PayPal! See README. - Disclose your usage of dear imgui via a dev blog post, a tweet, a screenshot, a mention somewhere etc. You may post screenshot or links in the gallery threads (github.com/ocornut/imgui/issues/1269). Visuals are ideal as they inspire other programmers.