Skip to content

Commit d0d14b7

Browse files
committed
Update README Setup Instructions
1 parent 2a9dea5 commit d0d14b7

File tree

1 file changed

+28
-15
lines changed

1 file changed

+28
-15
lines changed

README.md

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -109,33 +109,30 @@ If starting from `Ubuntu 24.04` you may need to update the Linux kernel to 6.11+
109109
build-essential clang clang-14 lld lld-14 cmake ninja-build python3-venv python3-pip
110110
```
111111

112-
1. Setup a virtual environment:
112+
1. Setup a virtual environment and activate it:
113113
```bash
114114
python3 -m venv ironenv
115115
source ironenv/bin/activate
116116
python3 -m pip install --upgrade pip
117117
```
118118

119+
1. Source XRT (installed in step 1):
120+
```bash
121+
source /opt/xilinx/xrt/setup.sh
122+
```
123+
119124
1. Install required Python packages (from requirements.txt):
120125
```bash
121126
MLIR_PYTHON_EXTRAS_SET_VERSION="0.0.8.3" HOST_MLIR_PYTHON_PACKAGE_PREFIX="aie" pip install -r requirements.txt
122127
```
123128

124-
### Git Hooks (Optional but Recommended)
125-
126-
To ensure your code passes CI linting checks before pushing, install the pre-push hook:
127-
128-
```bash
129-
cp scripts/hooks/pre-push .git/hooks/pre-push
130-
chmod +x .git/hooks/pre-push
131-
```
129+
1. To test your installation, you can try to build and run the example below:
130+
```bash
131+
cmake -B build
132+
cmake --build build --target silu_1_cols_1_channels_2048_tile_2048_run
133+
```
132134

133-
The hook will run the same linting checks as CI:
134-
- License checks (reuse)
135-
- Python formatting (black)
136-
- C++ formatting (clang-format)
137-
138-
To bypass the hook if needed: `git push --no-verify`
135+
Note: On a fresh install, if you get `CMake Error: Could not find CMAKE_ROOT !!!`, just deactivate and reactivate your python environment.
139136

140137
### Building & Testing
141138

@@ -179,6 +176,22 @@ Additionally a target to build & run is made available under the `<TARGET_NAME>_
179176
cmake --build build --target silu_4_cols_1_channels_2048_tile_512_run
180177
```
181178

179+
### Git Hooks (Optional but Recommended)
180+
181+
To ensure your code passes CI linting checks before pushing, install the pre-push hook:
182+
183+
```bash
184+
cp scripts/hooks/pre-push .git/hooks/pre-push
185+
chmod +x .git/hooks/pre-push
186+
```
187+
188+
The hook will run the same linting checks as CI:
189+
- License checks (reuse)
190+
- Python formatting (black)
191+
- C++ formatting (clang-format)
192+
193+
To bypass the hook if needed: `git push --no-verify`
194+
182195
-----
183196

184197
<p align="center">Copyright&copy; 2025 Advanced Micro Devices, Inc</p>

0 commit comments

Comments
 (0)