@@ -31,17 +31,56 @@ CIMFlow consists of two main components:
3131
3232## Prerequisites
3333
34- Before installing, ensure you have the following system dependencies:
34+ ### Python Environment
3535
36- - ** Python** : 3.11+
37- - ** Build Tools** : ` cmake ` (>=3.20), ` ninja-build ` , ` make ` , ` build-essential `
38- - ** Compiler** : ` clang ` , ` lld ` , ` ccache `
39- - ** Java** : ` openjdk-11-jdk ` (for ANTLR parser)
40- - ** Libraries** : ` libeigen3-dev ` , ` libunwind-dev `
36+ - ** Python 3.11 or later** is required.
37+
38+ We recommend using Conda for Python environment management:
39+
40+ ``` bash
41+ conda create -n cimflow python=3.11
42+ conda activate cimflow
43+ ```
44+
45+ > ** Note:** If you don't have Conda installed, see the [ Miniconda installation guide] ( https://docs.conda.io/en/latest/miniconda.html ) .
46+
47+ Alternatively, you can use venv:
48+
49+ ``` bash
50+ python3.11 -m venv .venv
51+ source .venv/bin/activate
52+ ```
53+
54+ ### System Dependencies
55+
56+ Install the required system packages (Ubuntu/Debian):
57+
58+ ``` bash
59+ # Build tools
60+ sudo apt install build-essential cmake ninja-build ccache
61+
62+ # Clang toolchain (for LLVM/MLIR build)
63+ sudo apt install clang lld
64+
65+ # Java Development Kit (for ANTLR parser)
66+ sudo apt install openjdk-11-jdk
67+
68+ # Required libraries
69+ sudo apt install libeigen3-dev libunwind-dev
70+ ```
4171
4272## Installation
4373
44- To install CIMFlow, its dependencies, and handle submodules, run the installation script:
74+ ### 1. Clone the Repository
75+
76+ ``` bash
77+ git clone https://github.com/BUAA-CI-LAB/CIMFlow.git
78+ cd CIMFlow
79+ ```
80+
81+ ### 2. Run Installation Script
82+
83+ With your virtual environment activated, run the installation script:
4584
4685``` bash
4786./install.sh
@@ -53,6 +92,8 @@ This script will:
53923 . Install the Python package and CLI tools.
54934 . Generate the default configuration in ` config/tool_paths.json ` .
5594
95+ > ** Tip:** Run ` ./install.sh --help ` for additional options (resume, repair, uninstall, etc.).
96+
5697## Configuration
5798
5899Runtime paths are defined in ` config/tool_paths.json ` . This file is automatically created during installation.
0 commit comments