From 8d4f03c8211a7b5528cd9fa8212d8f1e7baea485 Mon Sep 17 00:00:00 2001
From: Gustaf Rydholm <gustaf.rydholm@gmail.com>
Date: Sat, 7 Jan 2023 00:30:23 +0100
Subject: Add docs

---
 doc/no-clown-fiesta.txt | 62 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 doc/no-clown-fiesta.txt

(limited to 'doc')

diff --git a/doc/no-clown-fiesta.txt b/doc/no-clown-fiesta.txt
new file mode 100644
index 0000000..716c408
--- /dev/null
+++ b/doc/no-clown-fiesta.txt
@@ -0,0 +1,62 @@
+no-clown-fiesta.txt
+
+================================================================================
+CONTENTS                                                *no-clown-fiesta-contents*
+
+1. No Clown Fiesta...............................|no-clown-fiesta-no_clown_fiesta|
+    1.1. Usage.............................................|no-clown-fiesta-usage|
+    1.2. Supported Plugins.....................|no-clown-fiesta-supported_plugins|
+
+================================================================================
+NO CLOWN FIESTA                                  *no-clown-fiesta-no_clown_fiesta*
+
+An attempt at a color scheme that does not look like a clown puked up the source code.
+
+
+
+--------------------------------------------------------------------------------
+USAGE                                                      *no-clown-fiesta-usage*
+
+To enable this colorscheme:
+>
+    colorscheme no-clown-fiesta
+<
+>
+    vim.cmd[[colorscheme no-clown-fiesta]]
+<
+
+To override the default settings you need to call setup before enabling the
+colorscheme. No-clown-fiesta will use these settings, unless you call setup
+and override these.
+>
+    require("no-clown-fiesta").setup({
+      transparent = false, -- Enable this to disable the bg color
+      styles = { 
+        -- You can set any of the style values specified for `:h nvim_set_hl`
+        comments = {},
+        keywords = {},
+        functions = {},
+        variables = {},
+        type = { bold = true },
+      },
+    })
+<
+
+--------------------------------------------------------------------------------
+SUPPORTED PLUGINS                              *no-clown-fiesta-supported_plugins*
+
+*   Alpha
+*   Git
+*   Hop
+*   Lir
+*   LSP
+*   Lualine
+*   Markdown
+*   Neogit
+*   NvimCmp
+*   NvimTree
+*   Telescope
+*   Treesitter
+*   StatusLine (the default non custom one)
+*   WhichKey
+
-- 
cgit v1.2.3-70-g09d2