Skip to content

Commit a1f4332

Browse files
author
Viktor Chernev
authored
Update README.md
1 parent 2a3bec7 commit a1f4332

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ While ANTLR ensures strong grammar handling, the compiler is still under active
1818
In order to run the `DescribeCompilerCLI.exe` you need a Windows PC with DotNet framework version 8.0 or higher. In order to reference the `DescribeCompilerAPI.dll` in your DotNet projects, you need to target DotNet framework version 8.0 or higher. In order to use the Amazon Lambda project, on the other hand, you need to upload it to AWS. Also, be sure to check out our [wiki](https://github.com/viktorchernev/DescribeCompiler/wiki) for the complete documentation.
1919

2020
### 0. Set up highlighting
21-
In order to highlight Describe code, you can download the xml files for Notepad++ from the folder [Highlighting](https://github.com/viktorchernev/DescribeCompiler/tree/master/!highlighting), or use the instructions provided in said folder to set up your preferred text editor. (This approach to highlighting - using user-defined languages - is not ideal. it is somewhat hacky and simplistic, but works well enough in the absence of the more sophisticated approach that requires editor plugins, that we don't have yet)
21+
To enable Describe code highlighting, you can download the XML files for Notepad++ from the [Highlighting](https://github.com/viktorchernev/DescribeCompiler/tree/master/!highlighting) folder, or follow the instructions there to set up another text editor of your choice. This method uses user-defined languages for highlighting, which is a bit limited and makeshift, but it works reasonably well. A more refined solution using editor plugins isn’t available yet.
2222

2323
### 1. Write Describe code
2424
Write a title of each list, followed by an arrow `->` and the elements, one on a line, separated by comma `,` and end with a semicolon `;`. Add `[links]` in square brackets, and `<tag>` items in order to piece lists together. Add additional data as `{decorators}` in curly brackets or as tilde inversions - `~`. For more info visit the [documentation](https://documentation.listiary.com/)/[github](https://github.com/viktorchernev/DescribeCompiler/wiki/Grammar-How-To) or explore Describe source codes and test cases in this [huge collection](https://library.listiary.com/)/[github](https://github.com/viktorchernev/DataLists/tree/master/Lists).

0 commit comments

Comments
 (0)