cleanup

README.md

@@ -1,65 +1,5 @@
-[![Build Status](https://travis-ci.com/vortexgpgpu/vortex.svg?branch=master)](https://travis-ci.com/vortexgpgpu/vortex)
-[![codecov](https://codecov.io/gh/vortexgpgpu/vortex/branch/master/graph/badge.svg)](https://codecov.io/gh/vortexgpgpu/vortex)
+# Virgo Kernels
 
-# Vortex GPGPU
+This repo contains kernels written for the Virgo paper. It is adapted from the Vortex project repo.
 
-Vortex is a full-stack open-source RISC-V GPGPU.
-
-## Specifications
-
-- Support RISC-V RV32IMAF and RV64IMAFD
-- Microarchitecture:
-    - configurable number of cores, warps, and threads.
-    - configurable number of ALU, FPU, LSU, and SFU units per core.
-    - configurable pipeline issue width.
-    - optional shared memory, L1, L2, and L3 caches.
-- Software: 
-    - OpenCL 1.2 Support.
-- Supported FPGAs: 
-    - Altera Arria 10
-    - Altera Stratix 10
-    - Xilinx Alveo U50, U250, U280
-    - Xilinx Versal VCK5000
-
-## Directory structure
-
-- `doc`: [Documentation](docs/index.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.
-
-## Build Instructions
-More detailed build instructions can be found [here](docs/install_vortex.md).
-### Supported OS Platforms
-- Ubuntu 18.04, 20.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)
-- [FpNew](https://github.com/pulp-platform/fpnew.git)
-- [SoftFloat](https://github.com/ucb-bar/berkeley-softfloat-3.git)
-- [Ramulator](https://github.com/CMU-SAFARI/ramulator.git)
-- [Yosys](https://github.com/YosysHQ/yosys)
-- [Sv2v](https://github.com/zachjs/sv2v)
-### Install development tools 
-    $ sudo apt-get install build-essential
-    $ sudo apt-get install git
-### Install Vortex codebase
-    $ git clone --recursive https://github.com/vortexgpgpu/vortex.git
-    $ cd Vortex
-### Install prebuilt toolchain
-    By default, the toolchain will install to /opt folder which requires sudo access. 
-    You can install the toolchain to a different location of your choice by setting TOOLDIR (e.g. export TOOLDIR=$HOME/tools).
-    $ export TOOLDIR=/opt
-    $ ./ci/toolchain_install.sh --all
-    $ source ./ci/toolchain_env.sh
-### Build Vortex sources
-    $ make -s
-### Quick demo running vecadd OpenCL kernel on 2 cores
-    $ ./ci/blackbox.sh --cores=2 --app=vecadd
+More details to follow.