From e167f2f7b35f2fc7698f80743a538b3f11f052ef Mon Sep 17 00:00:00 2001 From: Rekkonnect Date: Mon, 3 Jun 2024 00:00:41 +0300 Subject: [PATCH] Adjust documents for v.1.1.1 --- README.md | 12 +++++++++-- Syndiesis/Syndiesis.csproj | 2 +- docs/changelog/1.0.x.md | 2 +- docs/changelog/1.1.x.md | 42 +++++++++++++++++++++++++++++++++++++- docs/changelog/README.md | 4 ++-- 5 files changed, 55 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c1f4d35..46812e4 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Despite not applying for the internship, I wanted to finish the project and rele ## Usage -Download from the [Releases](https://github.com/Rekkonnect/Syndiesis/releases) page. +For Windows, download from the [Releases](https://github.com/Rekkonnect/Syndiesis/releases) page. For macOS and Linux, you have to manually compile the program (refer to the section below). The program is designed to be cross-platform for desktop (including Windows, Linux and macOS). It's heavily tested to run on Windows 10, and it's moderately tested on Windows 11 and macOS. Please file an issue if platform-specific problems occur. @@ -21,6 +21,10 @@ Check the change log [here](/docs/changelog/README.md). View the [wiki](https://github.com/Rekkonnect/Syndiesis/wiki) for detailed documentation. +### Compiling + +To compile this program you will need an IDE like Visual Studio 2022, or JetBrains Rider 2024.1. Load the solution file (`Syndiesis.sln`) from the IDE of your choice and build the project (recommended to switch to *Release mode*). + ### Demo > _The video was shot in version 1.1.0_ @@ -45,6 +49,8 @@ Below is a short list of features: - Code editor - AvaloniaEdit's features + - Syntax and semantic colorization + - Go to definition using F12 - Custom nagivation to outer syntax nodes based on the current selection - Syntax and semantic analysis visualizer - Current caret syntax node highlighting @@ -59,9 +65,11 @@ Below is a short list of features: A large portion of the app is built using basic components in Avalonia. The code editor is from [AvaloniaEdit](https://github.com/avaloniaUI/AvaloniaEdit). Some icons were taken from the free version of [FontAwesome](https://fontawesome.com/). +Any issues regarding the code editor are most likely to be reported in [AvaloniaEdit](https://github.com/avaloniaUI/AvaloniaEdit). This includes behavior not specific to Syndiesis. Issues will be closed if they are specific to AvaloniaEdit, and must be reported there. + ### Desired features -Desired features are listed in the [issues](https://github.com/Rekkonnect/Syndiesis/issues). +Desired features among other issues are listed in the [issues](https://github.com/Rekkonnect/Syndiesis/issues). ### Ruled-out features diff --git a/Syndiesis/Syndiesis.csproj b/Syndiesis/Syndiesis.csproj index e43e7b0..4e438ee 100644 --- a/Syndiesis/Syndiesis.csproj +++ b/Syndiesis/Syndiesis.csproj @@ -9,7 +9,7 @@ - 1.1.0 + 1.1.1 Alex Kalfakakos © 2024 Alex Kalfakakos The most revolutionary syntax visualizer for C# diff --git a/docs/changelog/1.0.x.md b/docs/changelog/1.0.x.md index 8f834c6..ff8a94c 100644 --- a/docs/changelog/1.0.x.md +++ b/docs/changelog/1.0.x.md @@ -1,4 +1,4 @@ -# 1.0.x Changelog +# v1.0.x Changelog ## v1.0.3 diff --git a/docs/changelog/1.1.x.md b/docs/changelog/1.1.x.md index c299d4c..402d26d 100644 --- a/docs/changelog/1.1.x.md +++ b/docs/changelog/1.1.x.md @@ -1,4 +1,44 @@ -# 1.1.x Changelog +# v1.1.x Changelog + +## v1.1.1 + +### Improvements + +- General + - Include more referenced assemblies in the `Compilation` for the provided source +- Code editor + - Now using [AvaloniaEdit](https://github.com/avaloniaUI/AvaloniaEdit)! Thanks @danipen for the suggestion. + - Addresses #5, #33 and #34 + - Syntax and semantic colorization of the text (#4) + - F12 to navigate to definition of hovered symbol (#54) + - Selecting text now hovers on the deepest node that covers the entire selection span (#44) +- Analysis tree view + - Automatically recurringly navigate to node reflecting the current caret position upon re-analyzing (#50) + - No children on properties returning `ITypeSymbol` + - Use distinct enum field color for displayed enum values + - Avoid displaying `IAttributeOperation` nodes (#48) +- Settings + - Cancel and Reset buttons (#53) + +### Bugfixes + +- General + - Display correct title on macOS + - Fix commit SHA on window title + - App settings are correctly loaded on startup +- Analysis tree view + - Overlapping tree node spans are now resolved by the shortest text span (#51) + - Node hovering background not properly showing + +### Performance + +- Code editor + - Better responsiveness in large documents (#45) +- Analysis tree view + - Improve performance of identifying tree view node hovering + - Load child nodes in chunks + - Avoid unnecessary measure invalidations on `VerticallyExpandablePanel` + - Faster recurring expansion onto nodes ## v1.1.0 diff --git a/docs/changelog/README.md b/docs/changelog/README.md index 61c976f..99a429d 100644 --- a/docs/changelog/README.md +++ b/docs/changelog/README.md @@ -2,5 +2,5 @@ The change logs are split per version, listed below: -- [1.1.x](1.1.x.md) -- [1.0.x](1.0.x.md) +- [v1.1.x](1.1.x.md) +- [v1.0.x](1.0.x.md)