Skip to content

Commit e922bfe

Browse files
committed
Updated README for v0.6.0
1 parent 2836437 commit e922bfe

File tree

1 file changed

+53
-27
lines changed

1 file changed

+53
-27
lines changed

README.md

Lines changed: 53 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
[![Version](https://vsmarketplacebadge.apphb.com/version/appliedengdesign.vscode-gcode-syntax.svg)](https://marketplace.visualstudio.com/items?itemName=appliedengdesign.vscode-gcode-syntax)
22
[![Installs](https://vsmarketplacebadge.apphb.com/installs-short/appliedengdesign.vscode-gcode-syntax.svg)](https://marketplace.visualstudio.com/items?itemName=appliedengdesign.vscode-gcode-syntax)
33
[![Rating](https://vsmarketplacebadge.apphb.com/rating/appliedengdesign.vscode-gcode-syntax.svg)](https://marketplace.visualstudio.com/items?itemName=appliedengdesign.vscode-gcode-syntax)
4-
![CodeQL](https://github.com/appliedengdesign/vscode-gcode-syntax/actions/workflows/codeql-analysis.yml/badge.svg)
54

65
[![GitHub Issues](https://badgen.net/github/open-issues/appliedengdesign/vscode-gcode-syntax)](https://github.com/appliedengdesign/vscode-gcode-syntax/issues)
76
![Github Stars](https://badgen.net/github/stars/appliedengdesign/vscode-gcode-syntax)
@@ -36,21 +35,55 @@ You can also subscribe to our videos over on [YouTube](https://youtube.com/c/App
3635

3736
This extension adds language syntax for CNC G-Code, code snippets, and colorization.
3837

39-
- Tree View
40-
- Tree View shows an overview of the operations in the G-Code Program
41-
- Stats View
42-
- Stats View shows a number of stats like tool changes, runtime, etc.
43-
- Status Bar messages about code status.
38+
### Tree View
4439

45-
### Current Supported File Extensions
40+
- Tree View shows an overview of the operations in the G-Code Program
41+
42+
![Tree Screenshot](https://raw.githubusercontent.com/appliedengdesign/vscode-gcode-syntax/master/images/tree-screenshot.png)
43+
44+
### Stats View
45+
46+
- Stats View shows a number of stats like tool changes, runtime, etc.
47+
48+
![Stats Screenshot](https://raw.githubusercontent.com/appliedengdesign/vscode-gcode-syntax/master/images/stats-screenshot.png)
49+
50+
### Hovers
51+
52+
- Hovering over G/M codes will show a short description of the code
53+
- Descriptions for the codes are taken from the sister project: [gcode-reference](https://github.com/appliedengdesign/gcode-reference)
54+
- Hovers are dependent on the machine type selected
55+
56+
![Hovers Screenshot](https://raw.githubusercontent.com/appliedengdesign/vscode-gcode-syntax/master/images/hovers-screenshot.png)
57+
58+
### Status Bars
59+
60+
- G-Code adds three informative sections to the VSCode status bar area
61+
- Tree Status (Dirty or Up to Date) depending on Refresh needed
62+
- Current units as set by settings (Auto, Inch or Metric)
63+
- Machine Type as set by settings
64+
- Ok there's a little heart there too.
65+
66+
![Status Bar Screenshot](https://raw.githubusercontent.com/appliedengdesign/vscode-gcode-syntax/master/images/statusbar-screenshot.png)
67+
68+
### Context Menu
69+
70+
- G-Code adds several commands to the context menu when viewing g-code
71+
- Change selected code into a comment
72+
- Refresh Stats
73+
- Refresh Tree
74+
- Remove Comment from selected code
75+
76+
![Context Menu Screenshot](https://raw.githubusercontent.com/appliedengdesign/vscode-gcode-syntax/master/images/context-menu-screenshot.png)
77+
78+
## Current Supported File Extensions
4679

4780
```text
48-
| .001 | .apt | .aptcl | .cls | .cnc | .din | .dnc | .ecs |
49-
| .eia | .fan | .fgc | .fnc | .g00 | .gc | .gcd | .gcode |
50-
| .gp | .hnc | .knc | .lib | .m | .min | .mpf | .mpr |
51-
| .msb | .nc | .ncc | .ncd | .ncf | .ncg | .nci | .ncp |
52-
| .ngc | .out | .pim | .pit | .plt | .ply | .prg | .pu1 |
53-
| .rol | .sbp | .spf | .ssb | .sub | .tap | .xpi | |
81+
| .001 | .apt | .aptcl | .cls | .cnc | .din | .dnc | .ecs |
82+
| .eia | .fan | .fgc | .fnc | .g | .g00 | .gc | .gcd |
83+
| .gcode | .gp | .hnc | .knc | .lib | .m | .min | .mpf |
84+
| .mpr | .msb | .nc | .ncc | .ncd | .ncf | .ncg | .nci |
85+
| .ncp | .ngc | .out | .pim | .pit | .plt | .ply | .prg |
86+
| .pu1 | .rol | .sbp | .spf | .ssb | .sub | .tap | .xpi |
5487
```
5588

5689
If you would like another file extension supported by this extension, please [open an issue](https://github.com/appliedemgdesign/issues).
@@ -72,23 +105,16 @@ G-Code Syntax is customizable and provides many configuration settings to allow
72105
| Name | Description |
73106
| ------------------------------------ | -------------------------------------------------------------------------------------- |
74107
| `gcode.general.hovers.enabled` | Enable or Disable the hovers to show G-Code information |
75-
| | |
76108
| `gcode.general.machineType` | Choose the machine type for extension (Mill is default) |
77-
| | |
78109
| `gcode.general.statusBars.enabled` | Enable or Disable the G-Code status bars |
79-
| | |
80110
| `gcode.general.statusbars.alignment` | Choose the alignment of the status bars (Left is default) |
81-
| | |
82111
| `gcode.general.units` | Choose the units for the file. Options are Auto, Inch or Metric |
83-
| | |
84-
| `gcode.navTree.autoRefresh` | Tree auto-refreshes as changes are made to the g-code. ( Disabled by default ) |
85-
| | |
86-
| `gcode.stats.enabled` | Enable the statistics view. ( Disabled by default ) |
87-
| | |
88-
| `gcode.stats.autoRefresh` | Auto-refresh the stats view when changes are made to the g-code. (Disabled by default) |
89-
| | |
112+
| `gcode.views.maxAutoRefresh` | Value for limiting the autoRefresh maximum lines |
113+
| `gcode.views.navTree.autoRefresh` | Tree auto-refreshes as changes are made to the g-code. ( Disabled by default ) |
114+
| `gcode.views.stats.autoRefresh` | Auto-refresh the stats view when changes are made to the g-code. (Disabled by default) |
115+
| `gcode.views.webviews.enabled` | Enable or disable the webviews |
90116

91-
![Settings Screenshot](https://github.com/appliedengdesign/vscode-gcode-syntax/blob/master/images/settings-screenshot.png?raw=true)
117+
![Settings Screenshot](https://raw.githubusercontent.com/appliedengdesign/vscode-gcode-syntax/master/images/settings-screenshot.png)
92118

93119
## Known Issues
94120

@@ -99,7 +125,7 @@ Please visit our [GitHub Issues](https://github.com/appliedengdesign/vscode-gcod
99125
- Add more snippets
100126
- Add additional tree items.
101127
- More Statistics
102-
- Additional status bar messages
128+
- Line Numbering
103129
- G-Code Debugging
104130
- Backplotter
105131
- Semantic Highlighting
@@ -109,7 +135,7 @@ Visit our [projects page](https://github.com/appliedengdesign/vscode-gcode-synta
109135

110136
## Changelog
111137

112-
Latest Version: v0.5.1
138+
Latest Version: v0.6.0
113139

114140
Please refer to our [CHANGELOG](https://github.com/appliedengdesign/vscode-gcode-syntax/blob/master/CHANGELOG.md) doc.
115141

0 commit comments

Comments
 (0)