Merge remote-tracking branch 'origin/main' into main

README.md

@@ -1,7 +1,47 @@
 # Nuake
-A modern quake-inspired engine.
 
-# Build instructions
+
+# What is it
+Nuake is a game engine written from scratch by myself. It is not meant to be a end-all be-all engine and it is not a quakespasm type engine. This is a game engine that focuses on fast level design iteration that integrates with quake level editing software. If you can create quake maps, you can create Nuake levels. 
+`Warning: It is still very early in development and I dont recommend anyone using this to make their games *yet*. `
+
+# How to build
 1. Clone the repos
-2. Run cmake.bat
-3. 
+2. Run the `premake5` command
+3. Open the project generated by premake
+4. Run the editor
+
+# Contributing
+Feel free to make pull requests and I will look over them myself.
+
+# Documentation
+No documentation is currently available, I will try my best to work on this asap. 
+
+# Features
+- Trenchbroom integration with live reload
+- Native c++ scripting
+- fast ECS
+- Bullet physics
+- PBR rendering
+- Volumetric lighting
+- Parallax mapping
+- Scene tree system
+- Game in editor
+- Procedural & HDR skies
+- IBL
+
+# Planned
+- Advanced bullet physics features
+  - Soft bodies, Joints, etc.
+- Demo level
+- Serialization
+- C# scripting
+- Cross platform
+- Different rendering API(not a priority)
+- Triggers and entity editing in TB
+- Optimization
+- Water simulation
+- Terrain editing
+- Exporting
+- UI system
+- Custom shaders