docs update
This commit is contained in:
59
README.md
59
README.md
@@ -21,59 +21,32 @@ Vortex is a full-system RISCV-based GPGPU processor.
|
||||
## Directory structure
|
||||
|
||||
- `doc`: [Documentation](doc/Vortex.md).
|
||||
|
||||
- `hw`: Hardware sources.
|
||||
|
||||
- `driver`: Host drivers repository.
|
||||
|
||||
- `runtime`: Kernel Runtime software.
|
||||
|
||||
- `sim`: Simulators repository.
|
||||
|
||||
- `tests`: Tests repository.
|
||||
|
||||
- `ci`: Continuous integration scripts.
|
||||
|
||||
- `miscs`: Miscellaneous resources.
|
||||
|
||||
## Basic Installation
|
||||
|
||||
## Build Instructions
|
||||
### Supported OS Platforms
|
||||
- Ubuntu 18.04
|
||||
- Centos 7
|
||||
### Toolchain Dependencies
|
||||
- [POCL](http://portablecl.org/)
|
||||
- [LLVM](https://llvm.org/)
|
||||
- [RISCV-GNU-TOOLCHAIN](https://github.com/riscv-collab/riscv-gnu-toolchain)
|
||||
- [Verilator](https://www.veripool.org/verilator)
|
||||
### Install development tools
|
||||
|
||||
$ sudo apt-get install build-essential
|
||||
$ sudo apt-get install git
|
||||
|
||||
### Install gnu-riscv-tools
|
||||
|
||||
$ export RISCV_TOOLCHAIN_PATH=/opt/riscv-gnu-toolchain
|
||||
|
||||
$ sudo apt-get -y install \
|
||||
binutils build-essential libtool texinfo \
|
||||
gzip zip unzip patchutils curl git \
|
||||
make cmake ninja-build automake bison flex gperf \
|
||||
grep sed gawk python bc \
|
||||
zlib1g-dev libexpat1-dev libmpc-dev \
|
||||
libglib2.0-dev libfdt-dev libpixman-1-dev
|
||||
$ git clone https://github.com/riscv/riscv-gnu-toolchain
|
||||
$ cd riscv-gnu-toolchain
|
||||
$ git submodule update --init --recursive
|
||||
$ mkdir build
|
||||
$ cd build
|
||||
$ ../configure --prefix=$RISCV_TOOLCHAIN_PATH --with-arch=rv32im --with-abi=ilp32
|
||||
$ make -j`nproc`
|
||||
$ make -j`nproc` build-qemu
|
||||
|
||||
### Install Verilator
|
||||
|
||||
You need into build the latest version using the instructions on their website
|
||||
$ https://www.veripool.org/projects/verilator/wiki/Installing
|
||||
|
||||
### Install Vortex
|
||||
|
||||
### Install Vortex codebase
|
||||
$ git clone --recursive https://github.com/vortexgpgpu/vortex.git
|
||||
$ cd Vortex
|
||||
$ make
|
||||
|
||||
### Quick Test running OpenCL vecadd sample on 2 cores
|
||||
|
||||
$ ./ci/blackbox.sh --cores=2 --app=vecadd
|
||||
### Install prebuilt toolchain
|
||||
$ ./ci/toolchain_install.sh -all
|
||||
### Build Vortex sources
|
||||
$ make -s
|
||||
### Quick demo running vecadd OpenCL kernel on 2 cores
|
||||
$ ./ci/blackbox.sh --driver=rtlsim --cores=2 --app=vecadd
|
||||
|
||||
Reference in New Issue
Block a user