From 8761a2eb958ecb354bfd7ef9667adf15547bb72f Mon Sep 17 00:00:00 2001 From: Udayvir Singh <97400310+udayvir-singh@users.noreply.github.com> Date: Mon, 28 Aug 2023 20:33:53 +0530 Subject: [PATCH] [docs]: update version to v2.8 --- README.md | 2 +- doc/tangerine.txt | 10 ++++++++-- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d501b07..957b1d1 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,7 @@ local function bootstrap(url, ref) end -- for stable version [recommended] -bootstrap("https://github.com/udayvir-singh/tangerine.nvim", "v2.7") +bootstrap("https://github.com/udayvir-singh/tangerine.nvim", "v2.8") -- for git head bootstrap("https://github.com/udayvir-singh/tangerine.nvim") diff --git a/doc/tangerine.txt b/doc/tangerine.txt index 2e159a6..8d879cf 100644 --- a/doc/tangerine.txt +++ b/doc/tangerine.txt @@ -31,6 +31,7 @@ Tangerine provides a painless way to add fennel to your config. FEATURES *tangerine-features* + - _BLAZING_ fast, compile times in milliseconds - 100% support for interactive evaluation - Control over when and how to compile @@ -41,11 +42,13 @@ COMPARISON TO OTHER PLUGINS *tangerine-comparison-to-other-plugins* HOTPOT + - Abstracts too much away from the user. - Hooks onto lua package searchers to compile [harder to debug]. ANISEED + - Excessively feature rich for use in dotfiles. - Blindly compiles all files that it founds, resulting in slow load times. @@ -53,6 +56,7 @@ ANISEED ============================================================================== 2. Installation *tangerine-installation* + 1. Create file `plugin/0-tangerine.lua` to bootstrap tangerine: NOTE: if you are using lazy plugin @@ -90,12 +94,13 @@ information. end -- for stable version [recommended] - bootstrap("https://github.com/udayvir-singh/tangerine.nvim", "v2.7") + bootstrap("https://github.com/udayvir-singh/tangerine.nvim", "v2.8") -- for git head bootstrap("https://github.com/udayvir-singh/tangerine.nvim") < + 1. Call tangerine `setup()` function, see |tangerine-config| for valid options: >lua @@ -104,6 +109,7 @@ information. require "tangerine".setup {} < + 1. Invoke `:FnlCompile` manually or add hooks in |tangerine-setup|. Now start writing your config in `~/.config/nvim/init.fnl`. @@ -152,10 +158,10 @@ Lazy Lazy requires some extra setup to get working, because it interferes with package.path. + 1. Move tangerine’s bootstrap code to `~/.config/nvim/init.lua` instead of using `plugin/` dir to prevent an infinite loop caused by lazy. - 2. Disable `reset_packpath` in lazy’s config when calling the setup function: