From 9b24b089b41e4ff91a9a68e3d7403c71a90aac7a Mon Sep 17 00:00:00 2001
From: 4o1x5 <4o1x5@4o1x5.dev>
Date: Wed, 29 Jan 2025 18:39:11 +0100
Subject: [PATCH] docs: add trouble shooting for nix

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.md b/README.md
index c970d7f..45e80e3 100644
--- a/README.md
+++ b/README.md
@@ -72,6 +72,25 @@ This table represents how much will the theme look alike to it's original one. L
 | Ruby       | TODO           |
 | Swift      | TODO           |
 
+## Troubleshooting
+
+In some cases you might encouner an error like:
+```
+      > ======================================================
+       > No successful require checks.
+       >
+       > Require check failed for the following modules:
+       >   - shades_of_purple.shades_of_purple
+       > ======================================================
+```
+This can be solved by not checking this package
+```nix
+pkgs.vimUtils.buildVimPlugin {
+    ...
+    doCheck = false;
+    ...
+};
+```
 ## Made possible with
 
 - [lush.nvim](https://github.com/rktjmp/lush.nvim/) and it's [starter template](https://github.com/rktjmp/lush-template).