Skip to content

Commit d6ea08e

Browse files
committed
Updated README
Signed-off-by: Mike Centola <mcentola@appliedengdesign.com>
1 parent ae6f2d6 commit d6ea08e

1 file changed

Lines changed: 48 additions & 10 deletions

File tree

README.md

Lines changed: 48 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,43 @@
1-
# VSCode G-Code Syntax
2-
31
[![MIT License](https://badgen.net/badge/license/MIT)](https://opensource.org/licenses/MIT)
42
[![GitHub](https://badgen.net/github/release/appliedengdesign/vscode-gcode-syntax)](https://github.com/appliedengdesign/vscode-gcode-syntax)
53
[![GitHub Issues](https://badgen.net/github/open-issues/appliedengdesign/vscode-gcode-syntax)](https://github.com/appliedengdesign/vscode-gcode-syntax/issues)
64
![Gihub Stars](https://badgen.net/github/stars/appliedengdesign/vscode-gcode-syntax)
75
[![VS Marketplace Installs](https://badgen.net/vs-marketplace/i/appliedengdesign.vscode-gcode-syntax)](https://marketplace.visualstudio.com/items?itemName=appliedengdesign.vscode-gcode-syntax)
86
[![Follow @appliedengdesign](https://badgen.net/twitter/follow/appliedengdes)](https://twitter.com/appliedengdes)
97

10-
Language synax, IntelliSense, code snippits & more for writing G-Code for CNC machines, 3D printers, CNC routers, etc.
8+
<p align="center">
9+
<br />
10+
<img width="300" src="https://github.com/appliedengdesign/vscode-gcode-syntax/raw/master/images/logo.png" />
11+
<br /><br />
12+
</p>
13+
14+
VSCode G-Code Syntax is the premier extension for editing G-Code inside of VSCode. Going past the simple syntax highlighting, this extension aims to turn your editor into a full blown g-code management suite. Building on the features of VSCode like Intellisense, snippets, debugging and more, we are able to offer nearly all of the features you would see in very expensive proprietary editors.
15+
16+
Additionally, by editing your G-Code inside of VSCode, you can take advantage of source control using Git to manage your g-code file versions.
1117

1218
![Screenshot](https://raw.githubusercontent.com/appliedengdesign/vscode-gcode-syntax/master/images/screenshot.png)
1319

20+
>VSCode or [Visual Studio Code](https://code.visualstudio.com) is a FREE (as in beer), open source application for editing code of all kinds of programming languages. To make it even better, there is a great [marketplace](https://marketplace.visualstudio.com/VSCode) where you can download and add **extensions** to the application to support other languages, add features and more.
21+
22+
## Support VSCode-G-Code-Syntax
23+
24+
G-Code Syntax is generously offered to everyone free of charge, if you find it useful, please consider **supporting** the project by becoming a sponsor, sharing it, and letting your friends know!
25+
26+
Also, please [write a review](https://marketplace.visualstudio.com/items?itemName=appliedengdesign.vscode-gcode-syntax&ssr=false#review-details), [star me on GitHub](https://github.com/appliedengdesign/vscode-gcode-syntax 'Star me on GitHub'), and follow me on [Twitter](https://twitter.com/appliedengdes) or [Instagram](https://instagram.com/appliedengdes).
27+
28+
You can also subscribe to our videos over on [YouTube](https://youtube.com/c/AppliedEngDesignUSA).
29+
1430
## Features
1531

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

18-
There is also a tree-view of the G-Code, which parses the commands and gives you an overview of the program.
34+
- Tree View
35+
- Tree View shows an overview of the operations in the G-Code Program
36+
- Stats View
37+
- Stats View shows a number of stats like tool changes, runtime, etc.
38+
- Status Bar messages about code status.
1939

20-
### Current Supported Extensions
40+
### Current Supported File Extensions
2141

2242
- .m
2343
- .apt
@@ -53,6 +73,8 @@ There is also a tree-view of the G-Code, which parses the commands and gives you
5373
- .prg
5474
- .001
5575

76+
If you would like another file extension supported by this extension, please [open an issue](https://github.com/appliedemgdesign/issues).
77+
5678
## Installation
5779

5880
Install from Extensions Marketplace or manually install the `vsix` file.
@@ -63,12 +85,24 @@ Install & activate extension. Extension activates when you open a file marked fo
6385

6486
Tree view is enabled by default and can be access from the G icon on the activity bar.
6587

66-
## Configuration
88+
## G-Code Syntax Settings
89+
90+
G-Code Syntax is customizable and provides many configuration settings to allow the personalization of almost all features.
91+
92+
| Name | Description |
93+
| ----------------------------- | ------------------------------------------------------------------------------------------- |
94+
| `gcode.general.colorizaztion` | **( Not Currently Active )** |
95+
|
96+
| `gcode.general.machineType` | **( Not Currently Active )** |
97+
|
98+
| `gcode.tree.autoRefresh` | Tree auto-refreshes as changes are made to the g-code. ( Disabled by default ) |
99+
|
100+
| `gcode.stats.enable` | Enable the statistics view. ( Disabled by default ) |
101+
|
102+
| `gcode.stats.autoRefresh` | Auto-refresh the stats view when changes are made to the g-code. (Disabled by default) |
103+
|
67104

68-
- Colorization ( Not Currently Active )
69-
- Machine Type ( Not Currently Active )
70-
- Tree Auto-Refresh
71-
- Tree auto-refreshes as changes are made to the gcode. Disabled by default.
105+
![Settings Screenshot](https://github.com/appliedengdesign/vscode-gcode-syntax/blob/master/images/settings-screenshot.png?raw=true)
72106

73107
## Known Issues
74108

@@ -78,8 +112,12 @@ Please visit our [GitHub Issues](https://github.com/appliedengdesign/vscode-gcod
78112

79113
- Add more snippets
80114
- Add additional tree items.
115+
- More Statistics
116+
- Additional status bar messages
81117
- G-Code Debugging
82118
- Backplotter
119+
- Semantic Highlighting
120+
- Programmatic Language Server
83121

84122
## Changelog
85123

0 commit comments

Comments
 (0)