Skip to content

Commit 90082c2

Browse files
committed
change homepage link, improve readme
1 parent 9a8a377 commit 90082c2

2 files changed

Lines changed: 37 additions & 7 deletions

File tree

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,35 @@
1-
# NMF Package Generator
2-
3-
This [Yeoman](https://yeoman.io) generator is used to create a new [GLSP](https://langium.org/) extension for VS Code.
4-
5-
Please read the documentation to get started, as soon as this becomes available.
1+
# NMF Package Generator
2+
3+
This [Yeoman](https://yeoman.io) generator is used to create a new [GLSP](https://langium.org/) extension for VS Code, based on [NMF GLSP](https://nmfcode.github.io/glsp/index.html).
4+
5+
## Prerequisites
6+
7+
NMF GLSP requires a .NET SDK to be installed (at least .NET 8). To install it, follow the [instructions](https://github.com/dotnet/core/blob/main/release-notes/9.0/install.md) provided by Microsoft. Then, the generator itself can be installed via NPM. We recommend a systemwide installation.
8+
9+
```bash
10+
npm install generator-nmfglsp --global --save-dev
11+
```
12+
13+
## Using the generator
14+
15+
The code generator scaffolds a new NMF GLSP project. You can start it via the command line as follows:
16+
17+
```bash
18+
yo nmfglsp
19+
```
20+
21+
By default, the code generator is interactive and will ask for a range of details such as the name of your language and the features it should generate. Based on this information, the code generator will generate a new directory with the following artifacts already set up for you:
22+
23+
- An NMF GLSP diagram language for state machines
24+
- A C\# project that creates an GLSP server of your language
25+
- A node project that implements the GLSP client
26+
- A standalone web application that shows how to integrate the diagram into existing websites
27+
- A web application that packages your GLSP client into a web page to be used by a Visual Studio Code extension
28+
- A Visual Studio Code extension that integrates the GLSP server (using the web page from above)
29+
- Visual Studio Code launch configurations such that you can easily debug your VS Code extension
30+
31+
These artifacts are set up such that they integrate with each other. For example, the build directory of the GLSP server is exactly where the VS Code extension is expecting it.
32+
33+
## Launching the new extension
34+
35+
If you let the code generator generate a Visual Studio Code extension, the code generator will also compile the newly generated code and generate a launch configuration file that allows you to launch your new GLSP-based extension directly from the run menu in Visual Studio Code.

packages/generator-nmfglsp/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "generator-nmfglsp",
33
"version": "0.1.0",
44
"description": "Yeoman generator for NMF GLSP clients",
5-
"homepage": "https://github.com/NMFCode",
5+
"homepage": "https://nmfcode.github.io/glsp/",
66
"engines": {
77
"node": ">=16.0.0"
88
},
@@ -53,7 +53,7 @@
5353
"repository": {
5454
"type": "git",
5555
"url": "https://github.com/NMFCode/nmf-web-client",
56-
"directory": "packages/generator-nmf"
56+
"directory": "packages/generator-nmfglsp"
5757
},
5858
"bugs": "https://github.com/NMFCode/nmf-web-client/issues",
5959
"author": {

0 commit comments

Comments
 (0)