Skip to content

Commit 896eb09

Browse files
committed
docs update
1 parent cf3413c commit 896eb09

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,24 @@ More detailed build instructions can be found [here](docs/install_vortex.md).
6868
### Building Vortex
6969
$ make -s
7070
### Quick demo running vecadd OpenCL kernel on 2 cores
71-
$ ./ci/blackbox.sh --cores=2 --app=vecadd
71+
$ ./ci/blackbox.sh --cores=2 --app=vecadd
72+
73+
### Common Developer Tips
74+
- Installing Vortex kernel and runtime libraries to use with external tools requires passing --prefix=<install-path> to the configure script.
75+
```sh
76+
$ ../configure --xlen=32 --tooldir=$HOME/tools --prefix=<install-path>
77+
$ make -s
78+
$ make install
79+
``````
80+
- Building Vortex 64-bit simply requires using --xlen=64 configure option.
81+
```sh
82+
$ ../configure --xlen=32 --tooldir=$HOME/tools
83+
```
84+
- Sourcing "./ci/toolchain_env.sh" is required everytime you start a new terminal. we recommend adding "source <build-path>/ci/toolchain_env.sh" to your ~/.bashrc file to automate the process at login.
85+
```sh
86+
$ echo "source <build-path>/ci/toolchain_env.sh" >> ~/.bashrc
87+
```
88+
- Making changes to Makefiles in your source tree or adding new folders will require executing the "configure" script again to get it propagated into your build folder.
89+
```sh
90+
$ ../configure
91+
```

0 commit comments

Comments
 (0)