Skip to content

Commit

Permalink
docs: add installation instructions to README (#99)
Browse files Browse the repository at this point in the history
  • Loading branch information
mikesmithgh authored Dec 21, 2024
1 parent 06b9b95 commit f7e87cf
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 1 deletion.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,22 @@ sh -c "$(curl -s https://raw.githubusercontent.com/mikesmithgh/gruvsquirrel.nvim
> [read the script](https://github.com/mikesmithgh/gruvsquirrel.nvim/blob/main/scripts/mini.sh)
> before running `sh -c` directly from the web
## 📦 Installation

Using [lazy.nvim](https://github.com/folke/lazy.nvim):

```lua
{
'mikesmithgh/gruvsquirrel.nvim',
lazy = false,
priority = 1000,
config = function()
-- load colorscheme on startup
vim.cmd([[colorscheme gruvsquirrel]])
end,
}
```

## 🤝 Ackowledgements
- [gruvbox](https://github.com/morhetz/gruvbox)
> Designed as a bright theme with pastel 'retro groove' colors and light/dark mode switching in the way of solarized. The main focus when developing gruvbox is to keep colors easily distinguishable, contrast enough and still pleasant for the eyes.
Expand Down
20 changes: 19 additions & 1 deletion doc/gruvsquirrel.nvim.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
*gruvsquirrel.nvim.txt* For NVIM nightly Last change: 2023 July 23
*gruvsquirrel.nvim.txt* For NVIM nightly Last change: 2024 December 21

==============================================================================
Table of Contents *gruvsquirrel.nvim-table-of-contents*

1. gruvsquirrel.nvim |gruvsquirrel.nvim-gruvsquirrel.nvim|
- Quickstart |gruvsquirrel.nvim-gruvsquirrel.nvim-quickstart|
- Installation |gruvsquirrel.nvim-gruvsquirrel.nvim-installation|
- Ackowledgements |gruvsquirrel.nvim-gruvsquirrel.nvim-ackowledgements|


Expand Down Expand Up @@ -32,6 +33,23 @@ command:
<https://github.com/mikesmithgh/gruvsquirrel.nvim/blob/main/scripts/mini.sh>
before running `sh -c` directly from the web

INSTALLATION *gruvsquirrel.nvim-gruvsquirrel.nvim-installation*

Using lazy.nvim <https://github.com/folke/lazy.nvim>

>lua
{
'mikesmithgh/gruvsquirrel.nvim',
lazy = false,
priority = 1000,
config = function()
-- load colorscheme on startup
vim.cmd([[colorscheme gruvsquirrel]])
end,
}
<


ACKOWLEDGEMENTS *gruvsquirrel.nvim-gruvsquirrel.nvim-ackowledgements*

- gruvbox <https://github.com/morhetz/gruvbox>
Expand Down

0 comments on commit f7e87cf

Please sign in to comment.