Skip to content

Commit a103108

Browse files
authored
Fix section links in README.md
Fixed incorrect links in `README.md` and formatted the code
1 parent db068cc commit a103108

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This repository contains packages and tools to generate code for [Language Serve
44

55
It simplifies the creation of language servers for different programming languages by providing a robust and easy-to-use type generation system.
66

7-
➡️ For instructions on how to use the **code generator**, refer to the [Usage](#usage) section.
7+
➡️ For instructions on how to use the **code generator**, refer to the [Usage](#code-generator-usage) section.
88

99
➡️ For instructions on existing **plugins and packages** for different languages, refer to the table in the [Existing packages/plugins](#existing-packagesplugins) section.
1010

@@ -15,7 +15,7 @@ It simplifies the creation of language servers for different programming languag
1515
You will need a Python environment to run the generator. Here are the steps:
1616

1717
1. Create a Python environment: `python -m venv .venv`
18-
> **Note**: Python 3.8 is the minimum supported version
18+
> **Note**: Python 3.8 is the minimum supported version
1919
2. Activate the environment: `.venv\Scripts\activate` (Windows) or `source .venv/bin/activate` (Linux/macOS)
2020
3. Install this repo's tool: `python -m pip install git+https://github.com/microsoft/lsprotocol.git`
2121
4. Run your plugin. You can use the [command line](#command-line) or [Nox](#using-nox) to run the generator.
@@ -27,7 +27,7 @@ Clone this repository and run `generator` as a Python module.
2727
For example: `python -m generator --plugin dotnet --output-dir ./code`
2828

2929
```console
30-
>python -m generator --help
30+
> python -m generator --help
3131
usage: __main__.py [-h] [--model [MODEL [MODEL ...]]] --plugin PLUGIN
3232
[--output-dir OUTPUT_DIR]
3333

@@ -63,9 +63,9 @@ You can also use Nox to format code, run tests and run various tasks. Run `nox -
6363
Follow these steps to generate boilerplate code for a new plugin:
6464

6565
1. Create a virtual environment for Python using Python >= 3.8 and activate that environment.
66-
1. If you are using the Python extension for VS Code, you can just run the **Python: Create Environment** command from the Command Palette. Be sure to select all the `requirements.txt` files in the repo. This command will install all packages needed and select the newly created environment for you.
66+
1. If you are using the Python extension for VS Code, you can just run the **Python: Create Environment** command from the Command Palette. Be sure to select all the `requirements.txt` files in the repo. This command will install all packages needed and select the newly created environment for you.
6767
1. Ensure `nox` is installed.
68-
1. Run `nox --list` in the terminal. If Nox is installed, you should see a list of all available sessions. Otherwise, run `python -m pip install nox` in the activated environment you created above.
68+
1. Run `nox --list` in the terminal. If Nox is installed, you should see a list of all available sessions. Otherwise, run `python -m pip install nox` in the activated environment you created above.
6969
1. Run `nox --session create_plugin` and follow the prompts to create a new plugin.
7070

7171
Example:
@@ -83,10 +83,10 @@ nox > Session create_plugin was successful.
8383

8484
Below is the list of plugins already created using this package, with their respective package links.
8585

86-
| Language | Plugin Module | Package | Status | Documentation |
87-
| ---------------- | ------------------------ | --------------------------------------------------------------------------------------------------- | ----------------- | ----------------------------------------------------------- |
88-
| Python | generator.plugins.python | [![PyPI](https://img.shields.io/pypi/v/lsprotocol?label=lsprotocol)](https://pypi.org/p/lsprotocol) | Active | [Python package README](./packages/python/README.md) |
89-
| Rust | generator.plugins.rust | [![Crates](https://img.shields.io/crates/v/lsprotocol)](https://crates.io/crates/lsprotocol) | Active | [Rust package README](./packages/rust/lsprotocol/README.md) |
90-
| Dotnet | generator.plugins.dotnet | <in development> | Under development | <in development> |
91-
| Crystal | | [nobodywasishere/lsprotocol-crystal](https://github.com/nobodywasishere/lsprotocol-crystal) | Active | [CrystalDoc.info](https://crystaldoc.info/github/nobodywasishere/lsprotocol-crystal/main/index.html) |
92-
| Golang | | [myleshyson/lsprotocol-go](https://github.com/myleshyson/lsprotocol-go) | Active | [myleshyson/lsprotocol-go](https://github.com/myleshyson/lsprotocol-go) |
86+
| Language | Plugin Module | Package | Status | Documentation |
87+
| -------- | ------------------------ | --------------------------------------------------------------------------------------------------- | ----------------- | ---------------------------------------------------------------------------------------------------- |
88+
| Python | generator.plugins.python | [![PyPI](https://img.shields.io/pypi/v/lsprotocol?label=lsprotocol)](https://pypi.org/p/lsprotocol) | Active | [Python package README](./packages/python/README.md) |
89+
| Rust | generator.plugins.rust | [![Crates](https://img.shields.io/crates/v/lsprotocol)](https://crates.io/crates/lsprotocol) | Active | [Rust package README](./packages/rust/lsprotocol/README.md) |
90+
| Dotnet | generator.plugins.dotnet | <in development> | Under development | <in development> |
91+
| Crystal | | [nobodywasishere/lsprotocol-crystal](https://github.com/nobodywasishere/lsprotocol-crystal) | Active | [CrystalDoc.info](https://crystaldoc.info/github/nobodywasishere/lsprotocol-crystal/main/index.html) |
92+
| Golang | | [myleshyson/lsprotocol-go](https://github.com/myleshyson/lsprotocol-go) | Active | [myleshyson/lsprotocol-go](https://github.com/myleshyson/lsprotocol-go) |

0 commit comments

Comments
 (0)