Skip to content

Commit

Permalink
[docs]: update version to v2.8
Browse files Browse the repository at this point in the history
  • Loading branch information
udayvir-singh committed Aug 28, 2023
1 parent 7097548 commit 8761a2e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down
10 changes: 8 additions & 2 deletions doc/tangerine.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -41,18 +42,21 @@ 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.


==============================================================================
2. Installation *tangerine-installation*


1. Create file `plugin/0-tangerine.lua` to bootstrap tangerine:

NOTE: if you are using lazy <https://github.com/folke/lazy.nvim> plugin
Expand Down Expand Up @@ -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
Expand All @@ -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`.
Expand Down Expand Up @@ -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:


Expand Down

0 comments on commit 8761a2e

Please sign in to comment.