fix builds with nightly, update readme

README.md

@@ -1,3 +1,67 @@
 <h1 align="center">Kubi</h1>
-work in progress
+<p align="center">
+  Minecraft clone written in Rust
+</p>
+<div align="center">
+  <img src=".readme/game.gif" width="512">
+</div>
+<h2>features</h2>
+<p>
+  <ul>
+    <li>multithreaded procedural world generation</li>
+    <li>procedural structures</li>
+    <li>multithreaded mesh generation</li>
+    <li>cubic chunks (32x32x32)</li>
+    <li>low-level OpenGL renderer, targetting OpenGL ES 3.0</li>
+    <li>frustum culling</li>
+    <li>work-in-progress multiplayer support</li>
+    <li>block placement system</li>
+    <li>partial gamepad input support</li>
+  </ul>
+</p>
+
+<h2>building</h2>
+
+build/run
+
+```sh
+cargo build -p kubi
+cargo run -p kubi
+```
+
+build with nightly features
+
+```sh
+RUSTFLAGS="-C target-cpu=native" cargo +nightly build -p kubi -r --features nightly --
+```
+
+<h2>mutiplayer</h2>
+
+to join a multiplayer server, just pass the ip address as an argument
+
+```sh
+cargo run -p kubi -- 127.0.0.1:1234
+```
+
+<h2>server configuration</h2>
+
+```
+[server]
+address = "0.0.0.0:12345"     # ip address to bind to
+max_clients = 32              # max amount of connected clients
+timeout_ms = 10000            # client timeout in ms
+
+[world]
+seed = 0xfeb_face_dead_cafe   # worldgen seed to use
+
+[query]
+name = "Kubi Server"          # server name
+```
+
+<p>
+  <ul>
+    <li>multithreaded procedural world generation</li>
+  </ul>
+</p>
+
 <h6 align="right"><i>~ uwu</i></h6>

kubi-server/Cargo.toml

@@ -25,4 +25,4 @@ lz4_flex = { version = "0.10", default-features = false, features = ["std", "che
 [features]
 default = []
 safe_lz4 = ["lz4_flex/safe-encode", "lz4_flex/safe-decode"]
-nightly = ["hashbrown/nightly", "rand/nightly", "rand/simd_support", "serde/unstable", "glam/core-simd", "kubi-shared/nightly"]
+nightly = ["hashbrown/nightly", "rand/nightly", "rand/simd_support", "glam/core-simd", "kubi-shared/nightly"]

kubi-shared/Cargo.toml

@@ -19,4 +19,4 @@ rand_xoshiro = "0.6"
 
 [features]
 default = []
-nightly = ["rand/nightly", "rand/simd_support", "serde/unstable", "glam/core-simd"]
+nightly = ["rand/nightly", "rand/simd_support", "glam/core-simd"]

kubi/Cargo.toml

@@ -32,4 +32,4 @@ default = []
 generate_visualizer_data = ["serde_json", "shipyard/serde1"]
 safe_lz4 = ["lz4_flex/safe-encode", "lz4_flex/safe-decode"]
 parallel = ["shipyard/parallel"]
-nightly = ["glium/unstable", "hashbrown/nightly", "glam/core-simd", "kubi-shared/nightly"]
+nightly = ["hashbrown/nightly", "glam/core-simd", "kubi-shared/nightly"]