change project name to Kazan and reformat code
[kazan.git] / README.md
1 # Kazan
2
3 [![Build Status](https://travis-ci.org/kazan-3d/kazan.svg?branch=master)](https://travis-ci.org/kazan-3d/kazan)
4
5 Work-in-progress for Vulkan implementation on cpu
6
7 [TODO list](docs/todo.md)
8
9 [Documentation](docs)
10
11 ## Build in Docker
12
13 docker build -t kazan .
14
15 ## Build under Ubuntu 16.04 (xenial)
16
17 sudo apt install build-essential git clang-4.0 llvm-4.0-dev cmake zlib1g-dev libsdl2-dev
18 git clone https://github.com/kazan-3d/kazan.git
19 cd kazan
20 mkdir build
21 cd build
22 cmake .. -DCMAKE_CXX_COMPILER="`which clang++-4.0`" -DCMAKE_C_COMPILER="`which clang-4.0`" -DCMAKE_BUILD_TYPE=Debug
23 make
24
25 ## Naming
26
27 Kazan used to be named vulkan-cpu. Kazan is a Japanese word that means "volcano".