docs: add remappings info to installation

nomoixyz · Nov 21, 2023 · bc21d56 · bc21d56
1 parent 95ce186
commit bc21d56
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/docs/src/guide/installation.md b/docs/src/guide/installation.md
@@ -13,3 +13,11 @@ $ forge install nomoixyz/[email protected]
 ```
 
 Release tags can be found [here](https://github.com/nomoixyz/vulcan/releases)
+
+In order to minimize compatibility issues, `vulcan` uses a specific version of `forge-std`. To
+prevent these issues in your project you can add this to your remappings:
+
+```
+forge-std/=lib/vulcan/lib/forge-std/src/
+vulcan/=lib/vulcan/src/
+```