From 4d25d95a6c61339413863dacf2e7bd208fcb38ec Mon Sep 17 00:00:00 2001 From: Jannis Baum Date: Mon, 4 Dec 2023 20:08:52 +0100 Subject: [PATCH 1/2] docs: reorganize readme --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 5b6edafc..ff949872 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,20 @@ issue](https://github.com/jannis-baum/vivify/issues/new/choose) or - syntax highlighting for code - graphviz/dot graphs +### Editor Support + +Vivify has a simple API to integrate your favorite editor so the viewer live +updates to any changes as you are typing and the scrolling is smoothly +synchronized! + +See below for a list of existing editor plugins. In case your favorite editor is +not yet supported, use these as an example to write your own and add it to the +list! + +#### Existing integration + +- for Vim and Neovim: [vivify.vim](https://github.com/jannis-baum/vivify.vim) + ### Config Vivify will look for an optional config file at `~/.vivify/config.json` and @@ -73,27 +87,13 @@ following optional keys: available. Default Markdown extensions are `['markdown', 'md', 'mdown', 'mdwn', 'mkd', 'mkdn']` -## Usage +## Installation - make sure you have [`jq`](https://github.com/jqlang/jq) installed - download & unpack the latest release for your system (macOS or Linux) - add the two executables to your `$PATH` - run `viv ` to view `` -## Editor Support - -Vivify has a simple API to integrate your favorite editor so the viewer live -updates to any changes as you are typing and the scrolling is smoothly -synchronized! - -See below for a list of existing editor plugins. In case your favorite editor is -not yet supported, use these as an example to write your own and add it to the -list! - -### Existing integration - -- for Vim: [vivify.vim](https://github.com/jannis-baum/vivify.vim) - ## Get help Is something not working or do you have any questions? [Open an From 9a585ffeb6cf1513c936804576620f6b4ab23ce5 Mon Sep 17 00:00:00 2001 From: Jannis Baum Date: Mon, 4 Dec 2023 20:15:21 +0100 Subject: [PATCH 2/2] docs(#52): mention AUR package --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ff949872..9cf8cdc0 100644 --- a/README.md +++ b/README.md @@ -89,10 +89,20 @@ following optional keys: ## Installation +Once you have Vivify installed, use it by running `viv` with any text file or +directory as an argument! + +### Packaged + +- [AUR](https://aur.archlinux.org/packages/vivify), e.g. install with `yay -S vivify` + +### Manual + - make sure you have [`jq`](https://github.com/jqlang/jq) installed -- download & unpack the latest release for your system (macOS or Linux) +- download & unpack the [latest + release](https://github.com/jannis-baum/vivify/releases) for your system + (macOS or Linux) - add the two executables to your `$PATH` -- run `viv ` to view `` ## Get help