Skip to content

Commit

Permalink
[docs]: minor style changes
Browse files Browse the repository at this point in the history
  • Loading branch information
udayvir-singh committed Mar 1, 2023
1 parent 4f60c6f commit a17dfd9
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 18 deletions.
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ local pack = "tangerine" or "packer" or "paq"

local function bootstrap(url, ref)
local name = url:gsub(".*/", "")
local path = vim.fn.stdpath [[data]] .. "/site/pack/".. pack .. "/start/" .. name
local path = vim.fn.stdpath("data") .. "/site/pack/".. pack .. "/start/" .. name

if vim.fn.isdirectory(path) == 0 then
print(name .. ": installing in data dir...")
Expand All @@ -72,26 +72,24 @@ local function bootstrap(url, ref)
vim.fn.system {"git", "-C", path, "checkout", ref}
end

vim.cmd [[redraw]]
vim.cmd "redraw"
print(name .. ": finished installing")
end
end

-- for stable version [recommended]
bootstrap("https://github.com/udayvir-singh/tangerine.nvim", "v2.4")

-- for git head
bootstrap("https://github.com/udayvir-singh/tangerine.nvim")

-- for stable version
bootstrap("https://github.com/udayvir-singh/tangerine.nvim", "v2.4")
```

2. Call tangerine `setup()` function:
2. Call tangerine `setup()` function, see [config](#default-config) for valid options:

```lua
-- ~/.config/nvim/plugin/0-tangerine.lua

require "tangerine".setup {
[[ config, see below ]]
}
require "tangerine".setup {}
```

3. Invoke `:FnlCompile` manually or add hooks in [setup](#setup).
Expand Down
16 changes: 7 additions & 9 deletions doc/tangerine.txt
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ manager, you should create `/init.lua` instead.

local function bootstrap(url, ref)
local name = url:gsub(".*/", "")
local path = vim.fn.stdpath [[data]] .. "/site/pack/".. pack .. "/start/" .. name
local path = vim.fn.stdpath("data") .. "/site/pack/".. pack .. "/start/" .. name

if vim.fn.isdirectory(path) == 0 then
print(name .. ": installing in data dir...")
Expand All @@ -81,27 +81,25 @@ manager, you should create `/init.lua` instead.
vim.fn.system {"git", "-C", path, "checkout", ref}
end

vim.cmd [[redraw]]
vim.cmd "redraw"
print(name .. ": finished installing")
end
end

-- for stable version [recommended]
bootstrap("https://github.com/udayvir-singh/tangerine.nvim", "v2.4")

-- for git head
bootstrap("https://github.com/udayvir-singh/tangerine.nvim")

-- for stable version
bootstrap("https://github.com/udayvir-singh/tangerine.nvim", "v2.4")
<


1. Call tangerine `setup()` function:
1. Call tangerine `setup()` function, see |tangerine-config| for valid options:

>lua
-- ~/.config/nvim/plugin/0-tangerine.lua

require "tangerine".setup {
[[ config, see below ]]
}
require "tangerine".setup {}
<


Expand Down

0 comments on commit a17dfd9

Please sign in to comment.