From f452c04896799534481f045c0721cc5838727ae3 Mon Sep 17 00:00:00 2001 From: Felix Zeller Date: Tue, 27 Feb 2024 22:03:08 -0500 Subject: [PATCH 1/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index edd66945..ef4df08f 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ If you are using Arch Linux, you can install the latest Git version through the paru -S markdown-oxide-git ``` -### Manual +### Manual (for MacOS, Windows, and *other* linux distributions) Clone the repository and then run `cargo build --release`. From 159634692fac2f7f7b24f9aea1e8d5266bfc69c7 Mon Sep 17 00:00:00 2001 From: Felix Zeller Date: Tue, 27 Feb 2024 22:04:26 -0500 Subject: [PATCH 2/3] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index ef4df08f..80dd34de 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,8 @@ paru -S markdown-oxide-git Clone the repository and then run `cargo build --release`. +You will subsequently need the path to the release binary when you configure your editor. It can be found relative to the root of the project at `target/release/markdown-oxide` + ## Usage To use the language server, you need to follow the instructions for your editor of choice below. From 95b0815421fe578b7c1d40e259e1e096738799dc Mon Sep 17 00:00:00 2001 From: Felix Zeller Date: Tue, 27 Feb 2024 22:08:52 -0500 Subject: [PATCH 3/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 80dd34de..55e744f1 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ vim.api.nvim_exec_autocmds('User', { pattern = 'LspAttached' }) The linking syntax is that of Obsidian's and can be found here https://help.obsidian.md/Linking+notes+and+files/Internal+links -Generally, this is [[relativeFilePath(#heading)?(|display text|)?]] e.g. [[articles/markdown oxide#Features|Markdown Oxide Features]] to link to a heading in `Markdown Oxide.md` file in the `articles` folder or [[Obsidian]] for the `Obsidian.md` file in the root folder. +Generally, this is `[[relativeFilePath(#heading)?(|display text)?]]` e.g. [[articles/markdown oxide#Features|Markdown Oxide Features]] to link to a heading in `Markdown Oxide.md` file in the `articles` folder or [[Obsidian]] for the `Obsidian.md` file in the root folder. ## Features