Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
manjavacas committed Mar 28, 2023
1 parent 9cd6339 commit 72bda66
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,6 @@ A toolkit designed to facilitate the handling of MELCOR/MELGEN `1.8.6` files.
- Recursively extract inter-dependent `CFs`.
- Create submodels from a given `CV` (_beta_).

## ➕ Extensions

Includes **MELCOR Language Support** (`mls`): a MELCOR 1.8.6 syntax highlighter for Visual Studio Code.

Just copy the [`mls` folder](https://github.com/manjavacas/melkit/tree/main/vscode/mls) in `.vscode/extensions` for an improved MELCOR coding experience.

You can find the Visual Studio Code installation folder in the following paths:

* **Windows**: `%USERPROFILE%\.vscode\extensions`
* **macOS**: `~/.vscode/extensions`
* **Linux**: `~/.vscode/extensions`

## 💻 How to use

You simply need to instantiate a `Toolkit` with the name of the MELGEN file to manipulate and call those functions. For example:
Expand All @@ -44,6 +32,18 @@ cvs = toolkit.read_cvs()
fls = toolkit.read_fls()
```

## ➕ Extensions

Includes **MELCOR Language Support** (`mls`): a MELCOR 1.8.6 syntax highlighter for Visual Studio Code.

Just copy the [`mls` folder](https://github.com/manjavacas/melkit/tree/main/vscode/mls) in `.vscode/extensions` for an improved MELCOR coding experience.

You can find the Visual Studio Code installation folder in the following paths:

* **Windows**: `%USERPROFILE%\.vscode\extensions`
* **macOS**: `~/.vscode/extensions`
* **Linux**: `~/.vscode/extensions`

## 👐 Contributing

Feel free to contribute via _issues_ and _pull requests_.

0 comments on commit 72bda66

Please sign in to comment.