[Docs] Add Python Virtual Environment Setup Guide. (#373)

buddy-compiler · Aug 27, 2024 · 952d558 · 952d558
1 parent 5e5a6a5
commit 952d558
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -12,3 +12,6 @@
 
 # Clangd cache
 .cache
+
+# Clangd configurations
+.clangd
diff --git a/docs/PythonEnvironment.md b/docs/PythonEnvironment.md
@@ -0,0 +1,10 @@
+# Python Virtual Environment Setup Guide for Buddy-mlir
+
+We recommend you to use anaconda3 to create python virtual environment. You should install python packages as buddy-mlir/requirements.
+
+```bash
+$ conda create -n <your virtual environment name> python=3.11
+$ conda activate <your virtual environment name>
+$ cd buddy-mlir
+$ pip install -r requirements.txt
+```
diff --git a/docs/RVVEnviroment.md → docs/RVVEnvironment.md b/docs/RVVEnviroment.md → docs/RVVEnvironment.md
-Original file line number
+Diff line change
@@ Expand Up / @@ -12,3 +12,6 @@ @@
     # Clangd cache
     .cache
+    # Clangd configurations
+    .clangd