From: Jacob Lifshay <programmerjake@gmail.com>
Date: Wed, 26 Jul 2017 12:20:30 +0000 (-0700)
Subject: reformat and update README.md
X-Git-Tag: gsoc-2017~60
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=828014831f922ef1d70fa62a0345d499ca459e9a;p=kazan.git

reformat and update README.md
---

diff --git a/README.md b/README.md
index 1e4a75e..23db8a2 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,20 @@
-# Build under Ubuntu
-
-```sudo apt install software-properties-common wget
-wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
-sudo apt-add-repository 'deb http://apt.llvm.org/xenial/ llvm-toolchain-xenial-4.0 main'
-sudo apt update
-sudo apt install build-essential git clang-4.0 llvm-4.0-dev cmake zlib1g-dev
-git clone https://github.com/programmerjake/vulkan-cpu.git
-cd vulkan-cpu
-mkdir build
-cd build
-cmake .. -DCMAKE_CXX_COMPILER="`which clang++-4.0`" -DCMAKE_C_COMPILER="`which clang-4.0`" -DCMAKE_BUILD_TYPE=Debug
-make
-```
\ No newline at end of file
+# Vulkan-cpu
+
+Work-in-progress for Vulkan implementation on cpu
+
+## Build under Ubuntu 16.04 (xenial)
+
+    sudo apt install software-properties-common wget
+    wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
+    sudo apt-add-repository 'deb http://apt.llvm.org/xenial/ llvm-toolchain-xenial-4.0 main'
+    sudo apt update
+    sudo apt install build-essential git clang-4.0 llvm-4.0-dev cmake zlib1g-dev
+    git clone https://github.com/programmerjake/vulkan-cpu.git
+    cd vulkan-cpu
+    mkdir build
+    cd build
+    cmake .. -DCMAKE_CXX_COMPILER="`which clang++-4.0`" -DCMAKE_C_COMPILER="`which clang-4.0`" -DCMAKE_BUILD_TYPE=Debug
+    make
+
+Using the version of LLVM that comes with Ubuntu doesn't work.  
+See [Issue #1](https://github.com/programmerjake/vulkan-cpu/issues/1) for more details.