|
1 | | -# pdl-hl README |
| 1 | +# Python Data Library Syntax-Highlighting |
2 | 2 |
|
3 | | -This is the README for your extension "pdl-hl". After writing up a brief description, we recommend including the following sections. |
| 3 | +pdl-hl stands for Python Data Library Highlighter and it supports custom syntax highlighting for `.pdl` files in VSCode depending on your color theme. |
4 | 4 |
|
5 | 5 | ## Features |
6 | 6 |
|
7 | | -Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. |
8 | | - |
9 | | -For example if there is an image subfolder under your extension project workspace: |
10 | | - |
11 | | -\!\[feature X\]\(images/feature-x.png\) |
12 | | - |
13 | | -> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow. |
| 7 | +The only thing pdl-hl does is syntax highlighting and pdl language support once installed it should automaticly highlight within the `.pdl` file. If not press `Ctrl + Shift + P` to pull the command pallete up then type `change langauge mode` and search `pdl` then press `Enter` keywords, comments, types and doc-strings are highlighted. |
14 | 8 |
|
15 | 9 | ## Requirements |
16 | 10 |
|
17 | | -If you have any requirements or dependencies, add a section describing those and how to install and configure them. |
18 | | - |
19 | | -## Extension Settings |
20 | | - |
21 | | -Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. |
22 | | - |
23 | | -For example: |
24 | | - |
25 | | -This extension contributes the following settings: |
26 | | - |
27 | | -* `myExtension.enable`: Enable/disable this extension. |
28 | | -* `myExtension.thing`: Set to `blah` to do something. |
29 | | - |
30 | | -## Known Issues |
31 | | - |
32 | | -Calling out known issues can help limit users opening duplicate issues against your extension. |
33 | | - |
34 | | -## Release Notes |
35 | | - |
36 | | -Users appreciate release notes as you update your extension. |
37 | | - |
38 | | -### 1.0.0 |
39 | | - |
40 | | -Initial release of ... |
41 | | - |
42 | | -### 1.0.1 |
43 | | - |
44 | | -Fixed issue #. |
45 | | - |
46 | | -### 1.1.0 |
47 | | - |
48 | | -Added features X, Y, and Z. |
49 | | - |
50 | | ---- |
51 | | - |
52 | | -## Working with Markdown |
53 | | - |
54 | | -You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: |
55 | | - |
56 | | -* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux). |
57 | | -* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux). |
58 | | -* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets. |
| 11 | +pdl-hl is syntax highlighting for Python Data Librarys so its recommended [python 3.11](https://www.python.org/downloads/release/python-3110/) is installed to use the created `.pdl` files in programs it is also good to have the [PDL pypi package](https://pypi.org/project/pdlparse/) |
59 | 12 |
|
60 | | -## For more information |
| 13 | +## Releases and Updates |
61 | 14 |
|
62 | | -* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown) |
63 | | -* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/) |
| 15 | +This is the one and only release there will ever be of pdl-hl there are no live updates unless I get bored and return to this project for a 'revamp'. The syntax of pdl is made to be simple so this extension is not complicated at all, just simple highlighting however my python package [pdlparse](https://pypi.org/project/pdlparse/) will continue to get updates periodically. |
64 | 16 |
|
65 | | -**Enjoy!** |
| 17 | +[Python-Data-Library Github](https://github.com/itzCozi/Python-Data-Library) |
0 commit comments