Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jubnzv committed Aug 6, 2021
1 parent ca2aab7 commit 36af224
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,20 @@ It attempts to implement the basic functionality of org-mode's [evaluating code

![](./demo.gif)

## Installation
## Requirements
This plugin requires Neovim version 0.5+.

It works on Linux, MacOS and Windows (through WSL).

MacOS users should make sure that they have `coreutils` package installed:

```bash
brew install coreutils
```

This plugin requires Neovim version 0.5+. It works on Linux, MacOS and Windows (through WSL).
Windows users should have [installed WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10) with compilers/interpreters they want use.

## Installation

Install it with your plugin manager.

Expand All @@ -20,21 +31,12 @@ Then add the following line in your `init.lua`:
require 'mdeval'.setup()
```

You should also enable syntax highlighting inside code blocks in markdown using the built-in functionality.
Please define a list of markdown fenced languages in your configuration file:
You should also enable syntax highlighting inside code blocks for your languages using the built-in functionality:

```lua
vim.g.markdown_fenced_languages = {'python', 'cpp'}
```

MacOS users also should make sure that they have `coreutils` package installed:

```bash
brew install coreutils
```

And Windows users should have [installed WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10) with compilers/interpreters they want use.

## Usage

To use this plugin, you should move cursor inside a fenced code block with language identifier and execute the `:MdEval` command.
Expand Down

0 comments on commit 36af224

Please sign in to comment.