update readme and moving to Debian
authorJacob Lifshay <programmerjake@gmail.com>
Wed, 24 Oct 2018 05:24:15 +0000 (22:24 -0700)
committerJacob Lifshay <programmerjake@gmail.com>
Wed, 24 Oct 2018 05:24:15 +0000 (22:24 -0700)
README.md

index a838f2d9187b50adb64f15a9fcd3ec05425d63a6..8f4f6110d03930ef726028781a77eaffa4673aaa 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,27 @@
-# Kazan Software Renderer
+# Kazan
 
-This is the new Rust version. The previous C++ version is in the kazan-old branch. The version as of the end of GSOC 2017 is in the gsoc-2017 tag.
+Kazan is an in-progress Vulkan driver that supports cross-platform software rendering, and (eventually) is a driver for [libre-riscv.org's RISC-V based GPU](https://libre-riscv.org/3d_gpu/).
 
-The canonical location of this software is going to move to [kazan-3d.org](https://kazan-3d.org/)
+## License
+
+Kazan is licensed under the LGPL, v2.1 or later. See [LICENSE.md](https://salsa.debian.org/Kazan-team/kazan/blob/master/LICENSE.md) for details.
+
+Kazan uses third-party software, which has their own licenses.
+
+## Code of Conduct
+
+As part of Kazan being hosted by [Debian](https://www.debian.org/), it is important to follow the [Debian Code of Conduct](https://www.debian.org/code_of_conduct) when participating in Kazan's development.
+
+## Branches
+
+The [`master` branch](https://salsa.debian.org/Kazan-team/kazan/tree/master) is the new Rust version. The previous C++ version is in the [`kazan-old` branch](https://salsa.debian.org/Kazan-team/kazan/tree/kazan-old). The version as of the end of GSOC 2017 is in the [`gsoc-2017` tag](https://salsa.debian.org/Kazan-team/kazan/tree/gsoc-2017).
+
+## News
+
+### We've moved! - 2018-10-23
+
+Kazan's new canonical location is [salsa.debian.org/Kazan-team/kazan](https://salsa.debian.org/Kazan-team/kazan).
+
+The [Kazan GitHub repository](https://github.com/kazan-3d/kazan) is now used as a read-only mirror.
+
+Kazan's domain names, [kazan-3d.org](http://kazan-3d.org/) and [kazan.graphics](http://kazan.graphics), now redirect to Kazan's canonical location on Debian Salsa.