You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-11Lines changed: 12 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,17 +16,17 @@ The project was inspired by the task for applying into a Roslyn internship posit
16
16
17
17
The main design inspiration is [SharpLab](https://sharplab.io/). The syntax view feature of SharpLab is the main design that the app built upon.
18
18
19
-
Despite not applying for the internship, I wanted to finish the project and release it into a usable state without entering the depths of feature creep.
19
+
Despite not applying for the internship, I wanted to finish the project and release it into a usable state without entering the depths of feature creep. Feature creep inevitably occurred.
20
20
21
21
## Usage
22
22
23
-
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).
23
+
For Windows, Linux and macOS on x64 and arm64 architectures, download from the [Releases](https://github.com/Rekkonnect/Syndiesis/releases) page. You may still manually compile the program on your machine with the instructions written below.
24
24
25
-
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.
25
+
The program is designed to be cross-platform on desktop machines (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.
26
26
27
27
Check the change log [here](/docs/changelog/README.md).
28
28
29
-
View the [wiki](https://github.com/Rekkonnect/Syndiesis/wiki) for detailed documentation.
29
+
View the [wiki](https://github.com/Rekkonnect/Syndiesis/wiki) for detailed documentation, including a list of keybinds.
-[AvaloniaEdit](https://github.com/avaloniaUI/AvaloniaEdit) for the code editor
53
+
-[jamarino/IntervalTree](https://github.com/jamarino/IntervalTree) for the diagnostics
54
54
55
55
## Features
56
56
@@ -64,6 +64,7 @@ Below is a short list of features:
64
64
- Diagnostics display
65
65
- Automatic recognition of the snippet's language (C# or VB)
66
66
- Selection of any available language version
67
+
- Quick symbol info
67
68
- Syntax and semantic analysis visualizer
68
69
- Current caret syntax node highlighting
69
70
- Tree view of nodes
@@ -78,18 +79,18 @@ Below is a short list of features:
78
79
A large portion of the app is built using basic components in Avalonia. The code editor is from [AvaloniaEdit](https://github.com/avaloniaUI/AvaloniaEdit).
79
80
Some icons were taken from the free version of [FontAwesome](https://fontawesome.com/).
80
81
81
-
### Bugs and issues
82
+
### Bugs and Issues
82
83
83
84
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.
84
85
85
86
Syndiesis exposes data retrieved from Roslyn itself with minimal intervention for readability purposes. If you encounter misrepresented data, it is probably a Roslyn bug, but feel free to report it regardless. Examples of known Roslyn bugs include:
86
87
- Fixed buffer size expression has no symbol info ([dotnet/roslyn#75113](https://github.com/dotnet/roslyn/issues/75113))
87
88
88
-
### Desired features
89
+
### Desired Features
89
90
90
91
Desired features among other issues are listed in the [issues](https://github.com/Rekkonnect/Syndiesis/issues).
91
92
92
-
## Design philosophy
93
+
## Design Philosophy
93
94
94
95
The syntax visualizer should provide detailed information about how Roslyn parses the given C# code snippet, and in a pretty and user-friendly format. SharpLab lacks in readability of the tree, and it also doesn't paint the entire picture as intended.
0 commit comments