Merge branch 'master' of https://github.com/vortexgpgpu/vortex-dev into graphics

README.md

@@ -18,7 +18,7 @@ Directory structure
 
 - benchmarks: OpenCL and RISC-V benchmarks
  
-- docs: documentation.
+- docs: [documentation](https://github.com/vortexgpgpu/vortex-dev/blob/master/doc/Vortex.md).
 
 - hw: hardware sources.
 

doc/Simulation.md

@@ -33,3 +33,19 @@ Example use of command line arguments: Run the sgemm benchmark using the vlsim d
 
     $ ./ci/blackbox.sh --clusters=1 --cores=4 --warps=4 --threads=4 --driver=vlsim --app=sgemm
 
+Output from terminal:
+```
+Create context
+Create program from kernel source
+Upload source buffers
+Execute the kernel
+Elapsed time: 2463 ms
+Download destination buffer
+Verify result
+PASSED!
+PERF: core0: instrs=90802, cycles=52776, IPC=1.720517
+PERF: core1: instrs=90693, cycles=53108, IPC=1.707709
+PERF: core2: instrs=90849, cycles=53107, IPC=1.710678
+PERF: core3: instrs=90836, cycles=50347, IPC=1.804199
+PERF: instrs=363180, cycles=53108, IPC=6.838518
+```

doc/Vortex.md

@@ -0,0 +1,30 @@
+# Vortex Documentation
+
+### Table of Contents
+
+- Vortex Architecture
+- Vortex Software
+- [Vortex Simulation](https://github.com/vortexgpgpu/vortex-dev/blob/master/doc/Simulation.md)
+- [FPGA](https://github.com/vortexgpgpu/vortex-dev/blob/master/doc/Flubber_FPGA_Startup_Guide.md)
+- Debugging
+- Useful Links
+
+### Quick Start
+
+Setup Vortex environment:
+```
+$ export RISCV_TOOLCHAIN_PATH=/opt/riscv-gnu-toolchain
+$ export PATH=:/opt/verilator/bin:$PATH
+$ export VERILATOR_ROOT=/opt/verilator
+```
+
+Test Vortex with different drivers and configurations:
+- Run basic driver test with rtlsim driver and Vortex config of 2 clusters, 2 cores, 2 warps, 4 threads
+
+    $ ./ci/blackbox.sh --clusters=2 --cores=2 --warps=2 --threads=4 --driver=rtlsim --app=basic
+- Run demo driver test with vlsim driver and Vortex config of 1 clusters, 4 cores, 4 warps, 2 threads
+
+    $ ./ci/blackbox.sh --clusters=1 --cores=4 --warps=4 --threads=2 --driver=vlsim --app=demo
+- Run dogfood driver test with simx driver and Vortex config of 4 cluster, 4 cores, 8 warps, 6 threads 
+
+    $ ./ci/blackbox.sh --clusters=4 --cores=4 --warps=8 --threads=6 --driver=simx --app=dogfood